Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-customerinsights

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AuthorizationPoliciesCreateOrUpdateResponse

AuthorizationPoliciesCreateOrUpdateResponse: AuthorizationPolicyResourceFormat & object

Contains response data for the createOrUpdate operation.

AuthorizationPoliciesGetResponse

AuthorizationPoliciesGetResponse: AuthorizationPolicyResourceFormat & object

Contains response data for the get operation.

AuthorizationPoliciesListByHubNextResponse

AuthorizationPoliciesListByHubNextResponse: AuthorizationPolicyListResult & object

Contains response data for the listByHubNext operation.

AuthorizationPoliciesListByHubResponse

AuthorizationPoliciesListByHubResponse: AuthorizationPolicyListResult & object

Contains response data for the listByHub operation.

AuthorizationPoliciesRegeneratePrimaryKeyResponse

AuthorizationPoliciesRegeneratePrimaryKeyResponse: AuthorizationPolicy & object

Contains response data for the regeneratePrimaryKey operation.

AuthorizationPoliciesRegenerateSecondaryKeyResponse

AuthorizationPoliciesRegenerateSecondaryKeyResponse: AuthorizationPolicy & object

Contains response data for the regenerateSecondaryKey operation.

CalculationWindowTypes

CalculationWindowTypes: "Lifetime" | "Hour" | "Day" | "Week" | "Month"

Defines values for CalculationWindowTypes. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month'

readonly
enum

{string}

CanonicalPropertyValueType

CanonicalPropertyValueType: "Numeric" | "Categorical" | "DerivedCategorical" | "DerivedNumeric"

Defines values for CanonicalPropertyValueType. Possible values include: 'Numeric', 'Categorical', 'DerivedCategorical', 'DerivedNumeric'

readonly
enum

{string}

CardinalityTypes

CardinalityTypes: "OneToOne" | "OneToMany" | "ManyToMany"

Defines values for CardinalityTypes. Possible values include: 'OneToOne', 'OneToMany', 'ManyToMany'

readonly
enum

{string}

CompletionOperationTypes

CompletionOperationTypes: "DoNothing" | "DeleteFile" | "MoveFile"

Defines values for CompletionOperationTypes. Possible values include: 'DoNothing', 'DeleteFile', 'MoveFile'

readonly
enum

{string}

ConnectorMappingStates

ConnectorMappingStates: "Creating" | "Created" | "Failed" | "Ready" | "Running" | "Stopped" | "Expiring"

Defines values for ConnectorMappingStates. Possible values include: 'Creating', 'Created', 'Failed', 'Ready', 'Running', 'Stopped', 'Expiring'

readonly
enum

{string}

ConnectorMappingsCreateOrUpdateResponse

ConnectorMappingsCreateOrUpdateResponse: ConnectorMappingResourceFormat & object

Contains response data for the createOrUpdate operation.

ConnectorMappingsGetResponse

ConnectorMappingsGetResponse: ConnectorMappingResourceFormat & object

Contains response data for the get operation.

ConnectorMappingsListByConnectorNextResponse

ConnectorMappingsListByConnectorNextResponse: ConnectorMappingListResult & object

Contains response data for the listByConnectorNext operation.

ConnectorMappingsListByConnectorResponse

ConnectorMappingsListByConnectorResponse: ConnectorMappingListResult & object

Contains response data for the listByConnector operation.

ConnectorStates

ConnectorStates: "Creating" | "Created" | "Ready" | "Expiring" | "Deleting" | "Failed"

Defines values for ConnectorStates. Possible values include: 'Creating', 'Created', 'Ready', 'Expiring', 'Deleting', 'Failed'

readonly
enum

{string}

ConnectorTypes

ConnectorTypes: "None" | "CRM" | "AzureBlob" | "Salesforce" | "ExchangeOnline" | "Outbound"

Defines values for ConnectorTypes. Possible values include: 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', 'Outbound'

readonly
enum

{string}

ConnectorsBeginCreateOrUpdateResponse

ConnectorsBeginCreateOrUpdateResponse: ConnectorResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

ConnectorsCreateOrUpdateResponse

ConnectorsCreateOrUpdateResponse: ConnectorResourceFormat & object

Contains response data for the createOrUpdate operation.

ConnectorsGetResponse

ConnectorsGetResponse: ConnectorResourceFormat & object

Contains response data for the get operation.

ConnectorsListByHubNextResponse

ConnectorsListByHubNextResponse: ConnectorListResult & object

Contains response data for the listByHubNext operation.

ConnectorsListByHubResponse

ConnectorsListByHubResponse: ConnectorListResult & object

Contains response data for the listByHub operation.

DataSourceType

DataSourceType: "Connector" | "LinkInteraction" | "SystemDefault"

Defines values for DataSourceType. Possible values include: 'Connector', 'LinkInteraction', 'SystemDefault'

readonly
enum

{string}

EntityType

EntityType: "None" | "Profile" | "Interaction" | "Relationship"

Defines values for EntityType. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

readonly
enum

{string}

EntityTypes

EntityTypes: "None" | "Profile" | "Interaction" | "Relationship"

Defines values for EntityTypes. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

readonly
enum

{string}

ErrorManagementTypes

ErrorManagementTypes: "RejectAndContinue" | "StopImport" | "RejectUntilLimit"

Defines values for ErrorManagementTypes. Possible values include: 'RejectAndContinue', 'StopImport', 'RejectUntilLimit'

readonly
enum

{string}

FrequencyTypes

FrequencyTypes: "Minute" | "Hour" | "Day" | "Week" | "Month"

Defines values for FrequencyTypes. Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month'

readonly
enum

{string}

HubsCreateOrUpdateResponse

HubsCreateOrUpdateResponse: Hub & object

Contains response data for the createOrUpdate operation.

HubsGetResponse

HubsGetResponse: Hub & object

Contains response data for the get operation.

HubsListByResourceGroupNextResponse

HubsListByResourceGroupNextResponse: HubListResult & object

Contains response data for the listByResourceGroupNext operation.

HubsListByResourceGroupResponse

HubsListByResourceGroupResponse: HubListResult & object

Contains response data for the listByResourceGroup operation.

HubsListNextResponse

HubsListNextResponse: HubListResult & object

Contains response data for the listNext operation.

HubsListResponse

HubsListResponse: HubListResult & object

Contains response data for the list operation.

HubsUpdateResponse

HubsUpdateResponse: Hub & object

Contains response data for the update operation.

ImagesGetUploadUrlForDataResponse

ImagesGetUploadUrlForDataResponse: ImageDefinition & object

Contains response data for the getUploadUrlForData operation.

ImagesGetUploadUrlForEntityTypeResponse

ImagesGetUploadUrlForEntityTypeResponse: ImageDefinition & object

Contains response data for the getUploadUrlForEntityType operation.

InstanceOperationType

InstanceOperationType: "Upsert" | "Delete"

Defines values for InstanceOperationType. Possible values include: 'Upsert', 'Delete'

readonly
enum

{string}

InteractionsBeginCreateOrUpdateResponse

InteractionsBeginCreateOrUpdateResponse: InteractionResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

InteractionsCreateOrUpdateResponse

InteractionsCreateOrUpdateResponse: InteractionResourceFormat & object

Contains response data for the createOrUpdate operation.

InteractionsGetResponse

InteractionsGetResponse: InteractionResourceFormat & object

Contains response data for the get operation.

InteractionsListByHubNextResponse

InteractionsListByHubNextResponse: InteractionListResult & object

Contains response data for the listByHubNext operation.

InteractionsListByHubResponse

InteractionsListByHubResponse: InteractionListResult & object

Contains response data for the listByHub operation.

InteractionsSuggestRelationshipLinksResponse

InteractionsSuggestRelationshipLinksResponse: SuggestRelationshipLinksResponse & object

Contains response data for the suggestRelationshipLinks operation.

KpiBeginCreateOrUpdateResponse

KpiBeginCreateOrUpdateResponse: KpiResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

KpiCreateOrUpdateResponse

KpiCreateOrUpdateResponse: KpiResourceFormat & object

Contains response data for the createOrUpdate operation.

KpiFunctions

KpiFunctions: "Sum" | "Avg" | "Min" | "Max" | "Last" | "Count" | "None" | "CountDistinct"

Defines values for KpiFunctions. Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', 'None', 'CountDistinct'

readonly
enum

{string}

KpiGetResponse

KpiGetResponse: KpiResourceFormat & object

Contains response data for the get operation.

KpiListByHubNextResponse

KpiListByHubNextResponse: KpiListResult & object

Contains response data for the listByHubNext operation.

KpiListByHubResponse

KpiListByHubResponse: KpiListResult & object

Contains response data for the listByHub operation.

LinkTypes

LinkTypes: "UpdateAlways" | "CopyIfNull"

Defines values for LinkTypes. Possible values include: 'UpdateAlways', 'CopyIfNull'

readonly
enum

{string}

LinksBeginCreateOrUpdateResponse

LinksBeginCreateOrUpdateResponse: LinkResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

LinksCreateOrUpdateResponse

LinksCreateOrUpdateResponse: LinkResourceFormat & object

Contains response data for the createOrUpdate operation.

LinksGetResponse

LinksGetResponse: LinkResourceFormat & object

Contains response data for the get operation.

LinksListByHubNextResponse

LinksListByHubNextResponse: LinkListResult & object

Contains response data for the listByHubNext operation.

LinksListByHubResponse

LinksListByHubResponse: LinkListResult & object

Contains response data for the listByHub operation.

OperationsListNextResponse

OperationsListNextResponse: OperationListResult & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

PermissionTypes

PermissionTypes: "Read" | "Write" | "Manage"

Defines values for PermissionTypes. Possible values include: 'Read', 'Write', 'Manage'

readonly
enum

{string}

PredictionModelLifeCycle

PredictionModelLifeCycle: "New" | "Provisioning" | "ProvisioningFailed" | "PendingDiscovering" | "Discovering" | "PendingFeaturing" | "Featuring" | "FeaturingFailed" | "PendingTraining" | "Training" | "TrainingFailed" | "Evaluating" | "EvaluatingFailed" | "PendingModelConfirmation" | "Active" | "Deleted" | "HumanIntervention" | "Failed"

Defines values for PredictionModelLifeCycle. Possible values include: 'New', 'Provisioning', 'ProvisioningFailed', 'PendingDiscovering', 'Discovering', 'PendingFeaturing', 'Featuring', 'FeaturingFailed', 'PendingTraining', 'Training', 'TrainingFailed', 'Evaluating', 'EvaluatingFailed', 'PendingModelConfirmation', 'Active', 'Deleted', 'HumanIntervention', 'Failed'

readonly
enum

{string}

PredictionsBeginCreateOrUpdateResponse

PredictionsBeginCreateOrUpdateResponse: PredictionResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

PredictionsCreateOrUpdateResponse

PredictionsCreateOrUpdateResponse: PredictionResourceFormat & object

Contains response data for the createOrUpdate operation.

PredictionsGetModelStatusResponse

PredictionsGetModelStatusResponse: PredictionModelStatus & object

Contains response data for the getModelStatus operation.

PredictionsGetResponse

PredictionsGetResponse: PredictionResourceFormat & object

Contains response data for the get operation.

PredictionsGetTrainingResultsResponse

PredictionsGetTrainingResultsResponse: PredictionTrainingResults & object

Contains response data for the getTrainingResults operation.

PredictionsListByHubNextResponse

PredictionsListByHubNextResponse: PredictionListResult & object

Contains response data for the listByHubNext operation.

PredictionsListByHubResponse

PredictionsListByHubResponse: PredictionListResult & object

Contains response data for the listByHub operation.

ProfilesBeginCreateOrUpdateResponse

ProfilesBeginCreateOrUpdateResponse: ProfileResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

ProfilesCreateOrUpdateResponse

ProfilesCreateOrUpdateResponse: ProfileResourceFormat & object

Contains response data for the createOrUpdate operation.

ProfilesGetEnrichingKpisResponse

ProfilesGetEnrichingKpisResponse: Array<KpiDefinition> & object

Contains response data for the getEnrichingKpis operation.

ProfilesGetResponse

ProfilesGetResponse: ProfileResourceFormat & object

Contains response data for the get operation.

ProfilesListByHubNextResponse

ProfilesListByHubNextResponse: ProfileListResult & object

Contains response data for the listByHubNext operation.

ProfilesListByHubResponse

ProfilesListByHubResponse: ProfileListResult & object

Contains response data for the listByHub operation.

ProvisioningStates

ProvisioningStates: "Provisioning" | "Succeeded" | "Expiring" | "Deleting" | "HumanIntervention" | "Failed"

Defines values for ProvisioningStates. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed'

readonly
enum

{string}

RelationshipLinksBeginCreateOrUpdateResponse

RelationshipLinksBeginCreateOrUpdateResponse: RelationshipLinkResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

RelationshipLinksCreateOrUpdateResponse

RelationshipLinksCreateOrUpdateResponse: RelationshipLinkResourceFormat & object

Contains response data for the createOrUpdate operation.

RelationshipLinksGetResponse

RelationshipLinksGetResponse: RelationshipLinkResourceFormat & object

Contains response data for the get operation.

RelationshipLinksListByHubNextResponse

RelationshipLinksListByHubNextResponse: RelationshipLinkListResult & object

Contains response data for the listByHubNext operation.

RelationshipLinksListByHubResponse

RelationshipLinksListByHubResponse: RelationshipLinkListResult & object

Contains response data for the listByHub operation.

RelationshipsBeginCreateOrUpdateResponse

RelationshipsBeginCreateOrUpdateResponse: RelationshipResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

RelationshipsCreateOrUpdateResponse

RelationshipsCreateOrUpdateResponse: RelationshipResourceFormat & object

Contains response data for the createOrUpdate operation.

RelationshipsGetResponse

RelationshipsGetResponse: RelationshipResourceFormat & object

Contains response data for the get operation.

RelationshipsListByHubNextResponse

RelationshipsListByHubNextResponse: RelationshipListResult & object

Contains response data for the listByHubNext operation.

RelationshipsListByHubResponse

RelationshipsListByHubResponse: RelationshipListResult & object

Contains response data for the listByHub operation.

RoleAssignmentsBeginCreateOrUpdateResponse

RoleAssignmentsBeginCreateOrUpdateResponse: RoleAssignmentResourceFormat & object

Contains response data for the beginCreateOrUpdate operation.

RoleAssignmentsCreateOrUpdateResponse

RoleAssignmentsCreateOrUpdateResponse: RoleAssignmentResourceFormat & object

Contains response data for the createOrUpdate operation.

RoleAssignmentsGetResponse

RoleAssignmentsGetResponse: RoleAssignmentResourceFormat & object

Contains response data for the get operation.

RoleAssignmentsListByHubNextResponse

RoleAssignmentsListByHubNextResponse: RoleAssignmentListResult & object

Contains response data for the listByHubNext operation.

RoleAssignmentsListByHubResponse

RoleAssignmentsListByHubResponse: RoleAssignmentListResult & object

Contains response data for the listByHub operation.

RoleTypes

RoleTypes: "Admin" | "Reader" | "ManageAdmin" | "ManageReader" | "DataAdmin" | "DataReader"

Defines values for RoleTypes. Possible values include: 'Admin', 'Reader', 'ManageAdmin', 'ManageReader', 'DataAdmin', 'DataReader'

readonly
enum

{string}

RolesListByHubNextResponse

RolesListByHubNextResponse: RoleListResult & object

Contains response data for the listByHubNext operation.

RolesListByHubResponse

RolesListByHubResponse: RoleListResult & object

Contains response data for the listByHub operation.

Status

Status: "None" | "Active" | "Deleted"

Defines values for Status. Possible values include: 'None', 'Active', 'Deleted'

readonly
enum

{string}

ViewsCreateOrUpdateResponse

ViewsCreateOrUpdateResponse: ViewResourceFormat & object

Contains response data for the createOrUpdate operation.

ViewsGetResponse

ViewsGetResponse: ViewResourceFormat & object

Contains response data for the get operation.

ViewsListByHubNextResponse

ViewsListByHubNextResponse: ViewListResult & object

Contains response data for the listByHubNext operation.

ViewsListByHubResponse

ViewsListByHubResponse: ViewListResult & object

Contains response data for the listByHub operation.

WidgetTypesGetResponse

WidgetTypesGetResponse: WidgetTypeResourceFormat & object

Contains response data for the get operation.

WidgetTypesListByHubNextResponse

WidgetTypesListByHubNextResponse: WidgetTypeListResult & object

Contains response data for the listByHubNext operation.

WidgetTypesListByHubResponse

WidgetTypesListByHubResponse: WidgetTypeListResult & object

Contains response data for the listByHub operation.

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AssignmentPrincipal

AssignmentPrincipal: object
interface

An interface representing AssignmentPrincipal. The AssignmentPrincipal

principalId

principalId: string
member

{string} principalId The principal id being assigned to.

Optional principalMetadata

principalMetadata: undefined | object
member

{{ [propertyName: string]: string }} [principalMetadata] Other metadata for the principal.

principalType

principalType: string
member

{string} principalType The Type of the principal ID.

serializedName

serializedName: string = "AssignmentPrincipal"

type

type: object

className

className: string = "AssignmentPrincipal"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

required

required: true = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

principalMetadata

principalMetadata: object

serializedName

serializedName: string = "principalMetadata"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

principalType

principalType: object

required

required: true = true

serializedName

serializedName: string = "principalType"

type

type: object

name

name: "String" = "String"

Const AuthorizationPolicy

AuthorizationPolicy: object
interface

An interface representing AuthorizationPolicy. The authorization policy.

permissions

permissions: PermissionTypes[]
member

{PermissionTypes[]} permissions The permissions associated with the policy.

Optional policyName

policyName: undefined | string
member

{string} [policyName] Name of the policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryKey

primaryKey: undefined | string
member

{string} [primaryKey] Primary key assiciated with the policy.

Optional secondaryKey

secondaryKey: undefined | string
member

{string} [secondaryKey] Secondary key assiciated with the policy.

serializedName

serializedName: string = "AuthorizationPolicy"

type

type: object

className

className: string = "AuthorizationPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

permissions

permissions: object

required

required: true = true

serializedName

serializedName: string = "permissions"

constraints

constraints: object

UniqueItems

UniqueItems: true = true

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Read","Write","Manage"]

name

name: "Enum" = "Enum"

policyName

policyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

primaryKey

primaryKey: object

serializedName

serializedName: string = "primaryKey"

type

type: object

name

name: "String" = "String"

secondaryKey

secondaryKey: object

serializedName

serializedName: string = "secondaryKey"

type

type: object

name

name: "String" = "String"

Const AuthorizationPolicyListResult

AuthorizationPolicyListResult: object
interface

An interface representing the AuthorizationPolicyListResult. The response of list authorization policy operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "AuthorizationPolicyListResult"

__@iterator

  • Iterator

    Returns IterableIterator<AuthorizationPolicyResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns AuthorizationPolicyResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AuthorizationPolicyResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AuthorizationPolicyResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AuthorizationPolicyResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

find

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AuthorizationPolicyResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AuthorizationPolicyResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AuthorizationPolicyResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns AuthorizationPolicyResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns AuthorizationPolicyResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns AuthorizationPolicyResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AuthorizationPolicyResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AuthorizationPolicyResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AuthorizationPolicyResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns AuthorizationPolicyResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<AuthorizationPolicyResourceFormat>

type

type: object

className

className: string = "AuthorizationPolicyListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AuthorizationPolicyResourceFormat"

name

name: "Composite" = "Composite"

Const AuthorizationPolicyResourceFormat

AuthorizationPolicyResourceFormat: object
interface

An interface representing AuthorizationPolicyResourceFormat. The authorization policy resource format.

extends

ProxyResource

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

permissions

permissions: PermissionTypes[]
member

{PermissionTypes[]} permissions The permissions associated with the policy.

Optional policyName

policyName: undefined | string
member

{string} [policyName] Name of the policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryKey

primaryKey: undefined | string
member

{string} [primaryKey] Primary key assiciated with the policy.

Optional secondaryKey

secondaryKey: undefined | string
member

{string} [secondaryKey] Secondary key assiciated with the policy.

serializedName

serializedName: string = "AuthorizationPolicyResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "AuthorizationPolicyResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

permissions

permissions: object

required

required: true = true

serializedName

serializedName: string = "properties.permissions"

constraints

constraints: object

UniqueItems

UniqueItems: true = true

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Read","Write","Manage"]

name

name: "Enum" = "Enum"

policyName

policyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.policyName"

type

type: object

name

name: "String" = "String"

primaryKey

primaryKey: object

serializedName

serializedName: string = "properties.primaryKey"

type

type: object

name

name: "String" = "String"

secondaryKey

secondaryKey: object

serializedName

serializedName: string = "properties.secondaryKey"

type

type: object

name

name: "String" = "String"

Const AzureBlobConnectorProperties

AzureBlobConnectorProperties: object
interface

An interface representing AzureBlobConnectorProperties. The Azure Blob connector properties.

connectionKeyVaultUrl

connectionKeyVaultUrl: string
member

{string} connectionKeyVaultUrl The connection KeyVault URL.

serializedName

serializedName: string = "AzureBlobConnectorProperties"

type

type: object

className

className: string = "AzureBlobConnectorProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionKeyVaultUrl

connectionKeyVaultUrl: object

required

required: true = true

serializedName

serializedName: string = "connectionKeyVaultUrl"

type

type: object

name

name: "String" = "String"

Const CanonicalProfileDefinition

CanonicalProfileDefinition: object
interface

An interface representing CanonicalProfileDefinition. Definition of canonical profile.

Optional canonicalProfileId

canonicalProfileId: undefined | number
member

{number} [canonicalProfileId] Canonical profile ID.

Optional properties

member

{CanonicalProfileDefinitionPropertiesItem[]} [properties] Properties of the canonical profile.

serializedName

serializedName: string = "CanonicalProfileDefinition"

type

type: object

className

className: string = "CanonicalProfileDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

canonicalProfileId

canonicalProfileId: object

serializedName

serializedName: string = "canonicalProfileId"

type

type: object

name

name: "Number" = "Number"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CanonicalProfileDefinitionPropertiesItem"

name

name: "Composite" = "Composite"

Const CanonicalProfileDefinitionPropertiesItem

CanonicalProfileDefinitionPropertiesItem: object
interface

An interface representing CanonicalProfileDefinitionPropertiesItem. The definition of a canonical profile property.

Optional profileName

profileName: undefined | string
member

{string} [profileName] Profile name.

Optional profilePropertyName

profilePropertyName: undefined | string
member

{string} [profilePropertyName] Property name of profile.

Optional rank

rank: undefined | number
member

{number} [rank] The rank.

Optional value

value: undefined | string
member

{string} [value] Value of the canonical property.

serializedName

serializedName: string = "CanonicalProfileDefinition_propertiesItem"

Optional type

type: object
member

{CanonicalPropertyValueType} [type] Type of canonical property value. Possible values include: 'Numeric', 'Categorical', 'DerivedCategorical', 'DerivedNumeric'

className

className: string = "CanonicalProfileDefinitionPropertiesItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

profileName

profileName: object

serializedName

serializedName: string = "profileName"

type

type: object

name

name: "String" = "String"

profilePropertyName

profilePropertyName: object

serializedName

serializedName: string = "profilePropertyName"

type

type: object

name

name: "String" = "String"

rank

rank: object

serializedName

serializedName: string = "rank"

type

type: object

name

name: "Number" = "Number"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ConnectorListResult

ConnectorListResult: object
interface

An interface representing the ConnectorListResult. The response of list connector operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "ConnectorListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ConnectorResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ConnectorResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ConnectorResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ConnectorResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ConnectorResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ConnectorResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ConnectorResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ConnectorResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ConnectorResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ConnectorResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ConnectorResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ConnectorResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ConnectorResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns ConnectorResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns ConnectorResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ConnectorResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ConnectorResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ConnectorResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns ConnectorResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ConnectorResourceFormat>

type

type: object

className

className: string = "ConnectorListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectorResourceFormat"

name

name: "Composite" = "Composite"

Const ConnectorMappingAvailability

ConnectorMappingAvailability: object
interface

An interface representing ConnectorMappingAvailability. Connector mapping property availability.

Optional frequency

frequency: FrequencyTypes
member

{FrequencyTypes} [frequency] The frequency to update. Possible values include: 'Minute', 'Hour', 'Day', 'Week', 'Month'

interval

interval: number
member

{number} interval The interval of the given frequency to use.

serializedName

serializedName: string = "ConnectorMappingAvailability"

type

type: object

className

className: string = "ConnectorMappingAvailability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

frequency

frequency: object

serializedName

serializedName: string = "frequency"

type

type: object

allowedValues

allowedValues: string[] = ["Minute","Hour","Day","Week","Month"]

name

name: "Enum" = "Enum"

interval

interval: object

required

required: true = true

serializedName

serializedName: string = "interval"

type

type: object

name

name: "Number" = "Number"

Const ConnectorMappingCompleteOperation

ConnectorMappingCompleteOperation: object
interface

An interface representing ConnectorMappingCompleteOperation. The complete operation.

Optional completionOperationType

completionOperationType: CompletionOperationTypes
member

{CompletionOperationTypes} [completionOperationType] The type of completion operation. Possible values include: 'DoNothing', 'DeleteFile', 'MoveFile'

Optional destinationFolder

destinationFolder: undefined | string
member

{string} [destinationFolder] The destination folder where files will be moved to once the import is done.

serializedName

serializedName: string = "ConnectorMappingCompleteOperation"

type

type: object

className

className: string = "ConnectorMappingCompleteOperation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

completionOperationType

completionOperationType: object

serializedName

serializedName: string = "completionOperationType"

type

type: object

allowedValues

allowedValues: string[] = ["DoNothing","DeleteFile","MoveFile"]

name

name: "Enum" = "Enum"

destinationFolder

destinationFolder: object

serializedName

serializedName: string = "destinationFolder"

type

type: object

name

name: "String" = "String"

Const ConnectorMappingErrorManagement

ConnectorMappingErrorManagement: object
interface

An interface representing ConnectorMappingErrorManagement. The error mangement.

Optional errorLimit

errorLimit: undefined | number
member

{number} [errorLimit] The error limit allowed while importing data.

errorManagementType

errorManagementType: ErrorManagementTypes
member

{ErrorManagementTypes} errorManagementType The type of error management to use for the mapping. Possible values include: 'RejectAndContinue', 'StopImport', 'RejectUntilLimit'

serializedName

serializedName: string = "ConnectorMappingErrorManagement"

type

type: object

className

className: string = "ConnectorMappingErrorManagement"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorLimit

errorLimit: object

serializedName

serializedName: string = "errorLimit"

type

type: object

name

name: "Number" = "Number"

errorManagementType

errorManagementType: object

required

required: true = true

serializedName

serializedName: string = "errorManagementType"

type

type: object

allowedValues

allowedValues: string[] = ["RejectAndContinue","StopImport","RejectUntilLimit"]

name

name: "Enum" = "Enum"

Const ConnectorMappingFormat

ConnectorMappingFormat: object
interface

An interface representing ConnectorMappingFormat. Connector mapping property format.

Optional acceptLanguage

acceptLanguage: undefined | string
member

{string} [acceptLanguage] The oData language.

Optional arraySeparator

arraySeparator: undefined | string
member

{string} [arraySeparator] Character separating array elements.

Optional columnDelimiter

columnDelimiter: undefined | string
member

{string} [columnDelimiter] The character that signifies a break between columns.

Optional quoteCharacter

quoteCharacter: undefined | string
member

{string} [quoteCharacter] Quote character, used to indicate enquoted fields.

Optional quoteEscapeCharacter

quoteEscapeCharacter: undefined | string
member

{string} [quoteEscapeCharacter] Escape character for quotes, can be the same as the quoteCharacter.

serializedName

serializedName: string = "ConnectorMappingFormat"

type

type: object

className

className: string = "ConnectorMappingFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acceptLanguage

acceptLanguage: object

serializedName

serializedName: string = "acceptLanguage"

type

type: object

name

name: "String" = "String"

arraySeparator

arraySeparator: object

serializedName

serializedName: string = "arraySeparator"

type

type: object

name

name: "String" = "String"

columnDelimiter

columnDelimiter: object

serializedName

serializedName: string = "columnDelimiter"

type

type: object

name

name: "String" = "String"

formatType

formatType: object

defaultValue

defaultValue: string = "TextFormat"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "formatType"

type

type: object

name

name: "String" = "String"

quoteCharacter

quoteCharacter: object

serializedName

serializedName: string = "quoteCharacter"

type

type: object

name

name: "String" = "String"

quoteEscapeCharacter

quoteEscapeCharacter: object

serializedName

serializedName: string = "quoteEscapeCharacter"

type

type: object

name

name: "String" = "String"

Const ConnectorMappingListResult

ConnectorMappingListResult: object
interface

An interface representing the ConnectorMappingListResult. The response of list connector mapping operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "ConnectorMappingListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ConnectorMappingResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ConnectorMappingResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ConnectorMappingResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ConnectorMappingResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ConnectorMappingResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns ConnectorMappingResourceFormat[]

find

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ConnectorMappingResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ConnectorMappingResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ConnectorMappingResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ConnectorMappingResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns ConnectorMappingResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns ConnectorMappingResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ConnectorMappingResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ConnectorMappingResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ConnectorMappingResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns ConnectorMappingResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ConnectorMappingResourceFormat>

type

type: object

className

className: string = "ConnectorMappingListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectorMappingResourceFormat"

name

name: "Composite" = "Composite"

Const ConnectorMappingProperties

ConnectorMappingProperties: object
interface

An interface representing ConnectorMappingProperties. The connector mapping properties.

availability

member

{ConnectorMappingAvailability} availability The availability of mapping property.

completeOperation

member

{ConnectorMappingCompleteOperation} completeOperation The operation after import is done.

errorManagement

member

{ConnectorMappingErrorManagement} errorManagement The error management setting for the mapping.

Optional fileFilter

fileFilter: undefined | string
member

{string} [fileFilter] The file filter for the mapping.

Optional folderPath

folderPath: undefined | string
member

{string} [folderPath] The folder path for the mapping.

format

member

{ConnectorMappingFormat} format The format of mapping property.

Optional hasHeader

hasHeader: undefined | false | true
member

{boolean} [hasHeader] If the file contains a header or not.

structure

member

{ConnectorMappingStructure[]} structure Ingestion mapping information at property level.

serializedName

serializedName: string = "ConnectorMappingProperties"

type

type: object

className

className: string = "ConnectorMappingProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

availability

availability: object

required

required: true = true

serializedName

serializedName: string = "availability"

type

type: object

className

className: string = "ConnectorMappingAvailability"

name

name: "Composite" = "Composite"

completeOperation

completeOperation: object

required

required: true = true

serializedName

serializedName: string = "completeOperation"

type

type: object

className

className: string = "ConnectorMappingCompleteOperation"

name

name: "Composite" = "Composite"

errorManagement

errorManagement: object

required

required: true = true

serializedName

serializedName: string = "errorManagement"

type

type: object

className

className: string = "ConnectorMappingErrorManagement"

name

name: "Composite" = "Composite"

fileFilter

fileFilter: object

serializedName

serializedName: string = "fileFilter"

type

type: object

name

name: "String" = "String"

folderPath

folderPath: object

serializedName

serializedName: string = "folderPath"

type

type: object

name

name: "String" = "String"

format

format: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "format"

type

type: object

className

className: string = "ConnectorMappingFormat"

name

name: "Composite" = "Composite"

hasHeader

hasHeader: object

serializedName

serializedName: string = "hasHeader"

type

type: object

name

name: "Boolean" = "Boolean"

structure

structure: object

required

required: true = true

serializedName

serializedName: string = "structure"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnectorMappingStructure"

name

name: "Composite" = "Composite"

Const ConnectorMappingResourceFormat

ConnectorMappingResourceFormat: object
interface

An interface representing ConnectorMappingResourceFormat. The c onnector mapping resource format.

extends

ProxyResource

Optional connectorMappingName

connectorMappingName: undefined | string
member

{string} [connectorMappingName] The connector mapping name NOTE: This property will not be serialized. It can only be populated by the server.

Optional connectorName

connectorName: undefined | string
member

{string} [connectorName] The connector name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional connectorType

connectorType: ConnectorTypes
member

{ConnectorTypes} [connectorType] Type of connector. Possible values include: 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', 'Outbound'

Optional created

created: Date
member

{Date} [created] The created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataFormatId

dataFormatId: undefined | string
member

{string} [dataFormatId] The DataFormat ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string
member

{string} [description] The description of the connector mapping.

Optional displayName

displayName: undefined | string
member

{string} [displayName] Display name for the connector mapping.

entityType

entityType: EntityTypes
member

{EntityTypes} entityType Defines which entity type the file should map to. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

entityTypeName

entityTypeName: string
member

{string} entityTypeName The mapping entity name.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastModified

lastModified: Date
member

{Date} [lastModified] The last monified time. NOTE: This property will not be serialized. It can only be populated by the server.

mappingProperties

mappingProperties: ConnectorMappingProperties
member

{ConnectorMappingProperties} mappingProperties The properties of the mapping.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextRunTime

nextRunTime: Date
member

{Date} [nextRunTime] The next run time based on customer's settings. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runId

runId: undefined | string
member

{string} [runId] The RunId. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

member

{ConnectorMappingStates} [state] State of connector mapping. Possible values include: 'Creating', 'Created', 'Failed', 'Ready', 'Running', 'Stopped', 'Expiring' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ConnectorMappingResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ConnectorMappingResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectorMappingName

connectorMappingName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.connectorMappingName"

type

type: object

name

name: "String" = "String"

connectorName

connectorName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.connectorName"

type

type: object

name

name: "String" = "String"

connectorType

connectorType: object

serializedName

serializedName: string = "properties.connectorType"

type

type: object

name

name: "String" = "String"

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

dataFormatId

dataFormatId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.dataFormatId"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

entityType

entityType: object

required

required: true = true

serializedName

serializedName: string = "properties.entityType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Profile","Interaction","Relationship"]

name

name: "Enum" = "Enum"

entityTypeName

entityTypeName: object

required

required: true = true

serializedName

serializedName: string = "properties.entityTypeName"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

mappingProperties

mappingProperties: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "properties.mappingProperties"

type

type: object

className

className: string = "ConnectorMappingProperties"

name

name: "Composite" = "Composite"

nextRunTime

nextRunTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.nextRunTime"

type

type: object

name

name: "DateTime" = "DateTime"

runId

runId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.runId"

type

type: object

name

name: "String" = "String"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["Creating","Created","Failed","Ready","Running","Stopped","Expiring"]

name

name: "Enum" = "Enum"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

Const ConnectorMappingStructure

ConnectorMappingStructure: object
interface

An interface representing ConnectorMappingStructure. Connector mapping property structure.

columnName

columnName: string
member

{string} columnName The column name of the import file.

Optional customFormatSpecifier

customFormatSpecifier: undefined | string
member

{string} [customFormatSpecifier] Custom format specifier for input parsing.

Optional isEncrypted

isEncrypted: undefined | false | true
member

{boolean} [isEncrypted] Indicates if the column is encrypted.

propertyName

propertyName: string
member

{string} propertyName The property name of the mapping entity.

serializedName

serializedName: string = "ConnectorMappingStructure"

type

type: object

className

className: string = "ConnectorMappingStructure"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

columnName

columnName: object

required

required: true = true

serializedName

serializedName: string = "columnName"

type

type: object

name

name: "String" = "String"

customFormatSpecifier

customFormatSpecifier: object

serializedName

serializedName: string = "customFormatSpecifier"

type

type: object

name

name: "String" = "String"

isEncrypted

isEncrypted: object

serializedName

serializedName: string = "isEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

propertyName

propertyName: object

required

required: true = true

serializedName

serializedName: string = "propertyName"

type

type: object

name

name: "String" = "String"

Const ConnectorResourceFormat

ConnectorResourceFormat: object
interface

An interface representing ConnectorResourceFormat. The connector resource format.

extends

ProxyResource

Optional connectorId

connectorId: undefined | number
member

{number} [connectorId] ID of the connector. NOTE: This property will not be serialized. It can only be populated by the server.

Optional connectorName

connectorName: undefined | string
member

{string} [connectorName] Name of the connector.

connectorProperties

connectorProperties: object
member

{{ [propertyName: string]: any }} connectorProperties The connector properties.

Type declaration

  • [propertyName: string]: any

connectorType

connectorType: ConnectorTypes
member

{ConnectorTypes} connectorType Type of connector. Possible values include: 'None', 'CRM', 'AzureBlob', 'Salesforce', 'ExchangeOnline', 'Outbound'

Optional created

created: Date
member

{Date} [created] The created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string
member

{string} [description] Description of the connector.

Optional displayName

displayName: undefined | string
member

{string} [displayName] Display name of the connector.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isInternal

isInternal: undefined | false | true
member

{boolean} [isInternal] If this is an internal connector.

Optional lastModified

lastModified: Date
member

{Date} [lastModified] The last monified time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

member

{ConnectorStates} [state] State of connector. Possible values include: 'Creating', 'Created', 'Ready', 'Expiring', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ConnectorResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ConnectorResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectorId

connectorId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.connectorId"

type

type: object

name

name: "Number" = "Number"

connectorName

connectorName: object

serializedName

serializedName: string = "properties.connectorName"

type

type: object

name

name: "String" = "String"

connectorProperties

connectorProperties: object

required

required: true = true

serializedName

serializedName: string = "properties.connectorProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

connectorType

connectorType: object

required

required: true = true

serializedName

serializedName: string = "properties.connectorType"

type

type: object

name

name: "String" = "String"

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

isInternal

isInternal: object

serializedName

serializedName: string = "properties.isInternal"

type

type: object

name

name: "Boolean" = "Boolean"

lastModified

lastModified: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

allowedValues

allowedValues: string[] = ["Creating","Created","Ready","Expiring","Deleting","Failed"]

name

name: "Enum" = "Enum"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

Const CrmConnectorEntities

CrmConnectorEntities: object
interface

An interface representing CrmConnectorEntities. The CRM connector entities.

Optional displayName

displayName: undefined | string
member

{string} [displayName] The display name.

Optional isProfile

isProfile: undefined | false | true
member

{boolean} [isProfile] Indicating whether this is profile.

logicalName

logicalName: string
member

{string} logicalName The logical name.

serializedName

serializedName: string = "CrmConnectorEntities"

type

type: object

className

className: string = "CrmConnectorEntities"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

isProfile

isProfile: object

serializedName

serializedName: string = "isProfile"

type

type: object

name

name: "Boolean" = "Boolean"

logicalName

logicalName: object

required

required: true = true

serializedName

serializedName: string = "logicalName"

type

type: object

name

name: "String" = "String"

Const CrmConnectorProperties

CrmConnectorProperties: object
interface

An interface representing CrmConnectorProperties. The CRM connector properties.

Optional accessToken

accessToken: undefined | string
member

{string} [accessToken] The access token.

Optional connectionString

connectionString: undefined | string
member

{string} [connectionString] The connection string.

entities

member

{CrmConnectorEntities[]} entities The entities like account, contact, opportunity.

organizationId

organizationId: string
member

{string} organizationId The organization ID.

organizationUrl

organizationUrl: string
member

{string} organizationUrl The organization URL.

serializedName

serializedName: string = "CrmConnectorProperties"

type

type: object

className

className: string = "CrmConnectorProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessToken

accessToken: object

serializedName

serializedName: string = "accessToken"

type

type: object

name

name: "String" = "String"

connectionString

connectionString: object

serializedName

serializedName: string = "connectionString"

type

type: object

name

name: "String" = "String"

entities

entities: object

required

required: true = true

serializedName

serializedName: string = "entities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CrmConnectorEntities"

name

name: "Composite" = "Composite"

organizationId

organizationId: object

required

required: true = true

serializedName

serializedName: string = "organizationId"

type

type: object

name

name: "String" = "String"

organizationUrl

organizationUrl: object

required

required: true = true

serializedName

serializedName: string = "organizationUrl"

type

type: object

name

name: "String" = "String"

Const DataSourcePrecedence

DataSourcePrecedence: object
interface

An interface representing DataSourcePrecedence. The data source precedence is a way to know the precedence of each data source.

Optional dataSourceReferenceId

dataSourceReferenceId: undefined | string
member

{string} [dataSourceReferenceId] The data source reference id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataSourceType

dataSourceType: DataSourceType
member

{DataSourceType} [dataSourceType] The data source type. Possible values include: 'Connector', 'LinkInteraction', 'SystemDefault' NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | number
member

{number} [id] The data source ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The data source name NOTE: This property will not be serialized. It can only be populated by the server.

Optional precedence

precedence: undefined | number
member

{number} [precedence] the precedence value.

Optional status

status: Status
member

{Status} [status] The data source status. Possible values include: 'None', 'Active', 'Deleted' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DataSourcePrecedence"

type

type: object

className

className: string = "DataSourcePrecedence"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataSourceReferenceId

dataSourceReferenceId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataSource.dataSourceReferenceId"

type

type: object

name

name: "String" = "String"

dataSourceType

dataSourceType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataSource.dataSourceType"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataSource.id"

type

type: object

name

name: "Number" = "Number"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataSource.name"

type

type: object

name

name: "String" = "String"

precedence

precedence: object

serializedName

serializedName: string = "precedence"

type

type: object

name

name: "Number" = "Number"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataSource.status"

type

type: object

name

name: "String" = "String"

Const EnrichingKpi

EnrichingKpi: object
interface

An interface representing EnrichingKpi. The enriching KPI definition.

extends

KpiDefinition

Optional aliases

aliases: KpiAlias[]
member

{KpiAlias[]} [aliases] The aliases.

calculationWindow

calculationWindow: CalculationWindowTypes
member

{CalculationWindowTypes} calculationWindow The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month'

Optional calculationWindowFieldName

calculationWindowFieldName: undefined | string
member

{string} [calculationWindowFieldName] Name of calculation window field.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized description for the KPI.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the KPI.

entityType

entityType: EntityTypes
member

{EntityTypes} entityType The mapping entity type. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

entityTypeName

entityTypeName: string
member

{string} entityTypeName The mapping entity name.

expression

expression: string
member

{string} expression The computation expression for the KPI.

Optional extracts

extracts: KpiExtract[]
member

{KpiExtract[]} [extracts] The KPI extracts.

Optional filter

filter: undefined | string
member

{string} [filter] The filter expression for the KPI.

functionProperty

functionProperty: KpiFunctions
member

{KpiFunctions} functionProperty The computation function for the KPI. Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', 'None', 'CountDistinct'

Optional groupBy

groupBy: string[]
member

{string[]} [groupBy] the group by properties for the KPI.

Optional groupByMetadata

groupByMetadata: KpiGroupByMetadata[]
member

{KpiGroupByMetadata[]} [groupByMetadata] The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kpiName

kpiName: undefined | string
member

{string} [kpiName] The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional participantProfilesMetadata

participantProfilesMetadata: KpiParticipantProfilesMetadata[]
member

{KpiParticipantProfilesMetadata[]} [participantProfilesMetadata] The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thresHolds

thresHolds: KpiThresholds
member

{KpiThresholds} [thresHolds] The KPI thresholds.

Optional unit

unit: undefined | string
member

{string} [unit] The unit of measurement for the KPI.

serializedName

serializedName: string = "EnrichingKpi"

type

type: object

className

className: string = "EnrichingKpi"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const EntityTypeDefinition

EntityTypeDefinition: object
interface

An interface representing EntityTypeDefinition. Describes an entity.

extends

MetadataDefinitionBase

Optional apiEntitySetName

apiEntitySetName: undefined | string
member

{string} [apiEntitySetName] The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object.

Optional attributes

attributes: undefined | object
member

{{ [propertyName: string]: string[] }} [attributes] The attributes for the Type.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions for the property.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display names for the property.

Optional entityType

entityType: EntityTypes
member

{EntityTypes} [entityType] Type of entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

Optional fields

member

{PropertyDefinition[]} [fields] The properties of the Profile.

Optional instancesCount

instancesCount: undefined | number
member

{number} [instancesCount] The instance count.

Optional largeImage

largeImage: undefined | string
member

{string} [largeImage] Large Image associated with the Property or EntityType.

Optional lastChangedUtc

lastChangedUtc: Date
member

{Date} [lastChangedUtc] The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.

Optional localizedAttributes

localizedAttributes: undefined | object
member

{{ [propertyName: string]: { [propertyName: string]: string } }} [localizedAttributes] Any custom localized attributes for the Type.

Optional mediumImage

mediumImage: undefined | string
member

{string} [mediumImage] Medium Image associated with the Property or EntityType.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional schemaItemTypeLink

schemaItemTypeLink: undefined | string
member

{string} [schemaItemTypeLink] The schema org link. This helps ACI identify and suggest semantic models.

Optional smallImage

smallImage: undefined | string
member

{string} [smallImage] Small Image associated with the Property or EntityType.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timestampFieldName

timestampFieldName: undefined | string
member

{string} [timestampFieldName] The timestamp property name. Represents the time when the interaction or profile update happened.

Optional typeName

typeName: undefined | string
member

{string} [typeName] The name of the entity.

serializedName

serializedName: string = "EntityTypeDefinition"

type

type: object

className

className: string = "EntityTypeDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiEntitySetName

apiEntitySetName: object

serializedName

serializedName: string = "apiEntitySetName"

type

type: object

name

name: "String" = "String"

entityType

entityType: object

serializedName

serializedName: string = "entityType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Profile","Interaction","Relationship"]

name

name: "Enum" = "Enum"

fields

fields: object

serializedName

serializedName: string = "fields"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PropertyDefinition"

name

name: "Composite" = "Composite"

instancesCount

instancesCount: object

serializedName

serializedName: string = "instancesCount"

type

type: object

name

name: "Number" = "Number"

lastChangedUtc

lastChangedUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastChangedUtc"

type

type: object

name

name: "DateTime" = "DateTime"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "provisioningState"

type

type: object

name

name: "String" = "String"

schemaItemTypeLink

schemaItemTypeLink: object

serializedName

serializedName: string = "schemaItemTypeLink"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

timestampFieldName

timestampFieldName: object

serializedName

serializedName: string = "timestampFieldName"

type

type: object

name

name: "String" = "String"

typeName

typeName: object

serializedName

serializedName: string = "typeName"

type

type: object

name

name: "String" = "String"

Const GetImageUploadUrlInput

GetImageUploadUrlInput: object
interface

An interface representing GetImageUploadUrlInput. Input type for getting image upload url.

Optional entityType

entityType: undefined | string
member

{string} [entityType] Type of entity. Can be Profile or Interaction.

Optional entityTypeName

entityTypeName: undefined | string
member

{string} [entityTypeName] Name of the entity type.

Optional relativePath

relativePath: undefined | string
member

{string} [relativePath] Relative path of the image.

serializedName

serializedName: string = "GetImageUploadUrlInput"

type

type: object

className

className: string = "GetImageUploadUrlInput"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

entityType

entityType: object

serializedName

serializedName: string = "entityType"

type

type: object

name

name: "String" = "String"

entityTypeName

entityTypeName: object

serializedName

serializedName: string = "entityTypeName"

type

type: object

name

name: "String" = "String"

relativePath

relativePath: object

serializedName

serializedName: string = "relativePath"

type

type: object

name

name: "String" = "String"

Const Hub

Hub: object
interface

An interface representing Hub. Hub resource.

extends

Resource

Optional apiEndpoint

apiEndpoint: undefined | string
member

{string} [apiEndpoint] API endpoint URL of the hub. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hubBillingInfo

hubBillingInfo: HubBillingInfoFormat
member

{HubBillingInfoFormat} [hubBillingInfo] Billing settings of the hub.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] Provisioning state of the hub. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

Optional tenantFeatures

tenantFeatures: undefined | number
member

{number} [tenantFeatures] The bit flags for enabled hub features. Bit 0 is set to 1 indicates graph is enabled, or disabled if set to 0. Bit 1 is set to 1 indicates the hub is disabled, or enabled if set to 0.

Optional webEndpoint

webEndpoint: undefined | string
member

{string} [webEndpoint] Web endpoint URL of the hub. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Hub"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Hub"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiEndpoint

apiEndpoint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.apiEndpoint"

type

type: object

name

name: "String" = "String"

hubBillingInfo

hubBillingInfo: object

serializedName

serializedName: string = "properties.hubBillingInfo"

type

type: object

className

className: string = "HubBillingInfoFormat"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

tenantFeatures

tenantFeatures: object

serializedName

serializedName: string = "properties.tenantFeatures"

type

type: object

name

name: "Number" = "Number"

webEndpoint

webEndpoint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.webEndpoint"

type

type: object

name

name: "String" = "String"

Const HubBillingInfoFormat

HubBillingInfoFormat: object
interface

An interface representing HubBillingInfoFormat. Hub billing info.

Optional maxUnits

maxUnits: undefined | number
member

{number} [maxUnits] The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions.

Optional minUnits

minUnits: undefined | number
member

{number} [minUnits] The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions.

Optional skuName

skuName: undefined | string
member

{string} [skuName] The sku name.

serializedName

serializedName: string = "HubBillingInfoFormat"

type

type: object

className

className: string = "HubBillingInfoFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxUnits

maxUnits: object

serializedName

serializedName: string = "maxUnits"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 10

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

minUnits

minUnits: object

serializedName

serializedName: string = "minUnits"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 10

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

skuName

skuName: object

serializedName

serializedName: string = "skuName"

type

type: object

name

name: "String" = "String"

Const HubListResult

HubListResult: object
interface

An interface representing the HubListResult. Response of list hub operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link for next set of results.

serializedName

serializedName: string = "HubListResult"

__@iterator

  • __@iterator(): IterableIterator<Hub>
  • Iterator

    Returns IterableIterator<Hub>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Hub>[]): Hub[]
  • concat(...items: (T | ConcatArray<T>)[]): Hub[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Hub>[]

      Additional items to add to the end of array1.

    Returns Hub[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Hub[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Hub]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Hub]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Hub, index: number, array: Hub[]): boolean
        • Parameters

          • value: Hub
          • index: number
          • array: Hub[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Hub, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Hub

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Hub[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Hub, index: number, array: Hub[]): boolean
        • Parameters

          • value: Hub
          • index: number
          • array: Hub[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Hub, index: number, array: Hub[]): any
        • Parameters

          • value: Hub
          • index: number
          • array: Hub[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Hub[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Hub | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Hub, index: number, obj: Hub[]): boolean
        • Parameters

          • this: void
          • value: Hub
          • index: number
          • obj: Hub[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Hub, index: number, obj: Hub[]): boolean
        • Parameters

          • value: Hub
          • index: number
          • obj: Hub[]

          Returns boolean

    • Optional thisArg: any

    Returns Hub | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Hub, index: number, obj: Hub[]): boolean
        • Parameters

          • value: Hub
          • index: number
          • obj: Hub[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Hub, index: number, array: Hub[]): void
        • Parameters

          • value: Hub
          • index: number
          • array: Hub[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Hub, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Hub

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Hub, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Hub

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Hub, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Hub

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Hub, index: number, array: Hub[]): U
        • Parameters

          • value: Hub
          • index: number
          • array: Hub[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Hub | undefined
  • Removes the last element from an array and returns it.

    Returns Hub | undefined

push

  • push(...items: Hub[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Hub[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Hub
  • reduce(callbackfn: function, initialValue: Hub): Hub
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Hub, currentValue: Hub, currentIndex: number, array: Hub[]): Hub
        • Parameters

          • previousValue: Hub
          • currentValue: Hub
          • currentIndex: number
          • array: Hub[]

          Returns Hub

    Returns Hub

  • Parameters

    • callbackfn: function
        • (previousValue: Hub, currentValue: Hub, currentIndex: number, array: Hub[]): Hub
        • Parameters

          • previousValue: Hub
          • currentValue: Hub
          • currentIndex: number
          • array: Hub[]

          Returns Hub

    • initialValue: Hub

    Returns Hub

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Hub, currentIndex: number, array: Hub[]): U
        • Parameters

          • previousValue: U
          • currentValue: Hub
          • currentIndex: number
          • array: Hub[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Hub
  • reduceRight(callbackfn: function, initialValue: Hub): Hub
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Hub, currentValue: Hub, currentIndex: number, array: Hub[]): Hub
        • Parameters

          • previousValue: Hub
          • currentValue: Hub
          • currentIndex: number
          • array: Hub[]

          Returns Hub

    Returns Hub

  • Parameters

    • callbackfn: function
        • (previousValue: Hub, currentValue: Hub, currentIndex: number, array: Hub[]): Hub
        • Parameters

          • previousValue: Hub
          • currentValue: Hub
          • currentIndex: number
          • array: Hub[]

          Returns Hub

    • initialValue: Hub

    Returns Hub

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Hub, currentIndex: number, array: Hub[]): U
        • Parameters

          • previousValue: U
          • currentValue: Hub
          • currentIndex: number
          • array: Hub[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Hub[]
  • Reverses the elements in an Array.

    Returns Hub[]

shift

  • shift(): Hub | undefined
  • Removes the first element from an array and returns it.

    Returns Hub | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Hub[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Hub[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Hub, index: number, array: Hub[]): boolean
        • Parameters

          • value: Hub
          • index: number
          • array: Hub[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Hub[]
  • splice(start: number, deleteCount: number, ...items: Hub[]): Hub[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Hub[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Hub[]

      Elements to insert into the array in place of the deleted elements.

    Returns Hub[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Hub[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Hub[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Hub>
  • Returns an iterable of values in the array

    Returns IterableIterator<Hub>

type

type: object

className

className: string = "HubListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Hub"

name

name: "Composite" = "Composite"

Const ImageDefinition

ImageDefinition: object
interface

An interface representing ImageDefinition. The image definition.

Optional contentUrl

contentUrl: undefined | string
member

{string} [contentUrl] Content URL for the image blob.

Optional imageExists

imageExists: undefined | false | true
member

{boolean} [imageExists] Whether image exists already.

Optional relativePath

relativePath: undefined | string
member

{string} [relativePath] Relative path of the image.

serializedName

serializedName: string = "ImageDefinition"

type

type: object

className

className: string = "ImageDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentUrl

contentUrl: object

serializedName

serializedName: string = "contentUrl"

type

type: object

name

name: "String" = "String"

imageExists

imageExists: object

serializedName

serializedName: string = "imageExists"

type

type: object

name

name: "Boolean" = "Boolean"

relativePath

relativePath: object

serializedName

serializedName: string = "relativePath"

type

type: object

name

name: "String" = "String"

Const InteractionListResult

InteractionListResult: object
interface

An interface representing the InteractionListResult. The response of list interaction operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "InteractionListResult"

__@iterator

  • Iterator

    Returns IterableIterator<InteractionResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns InteractionResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns InteractionResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, InteractionResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: InteractionResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): InteractionResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns InteractionResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): InteractionResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns InteractionResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: InteractionResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: InteractionResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: InteractionResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns InteractionResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns InteractionResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns InteractionResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns InteractionResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns InteractionResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: InteractionResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns InteractionResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<InteractionResourceFormat>

type

type: object

className

className: string = "InteractionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InteractionResourceFormat"

name

name: "Composite" = "Composite"

Const InteractionResourceFormat

InteractionResourceFormat: object
interface

An interface representing InteractionResourceFormat. The interaction resource format.

extends

ProxyResource

Optional apiEntitySetName

apiEntitySetName: undefined | string
member

{string} [apiEntitySetName] The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object.

Optional attributes

attributes: undefined | object
member

{{ [propertyName: string]: string[] }} [attributes] The attributes for the Type.

Optional dataSourcePrecedenceRules

dataSourcePrecedenceRules: DataSourcePrecedence[]
member

{DataSourcePrecedence[]} [dataSourcePrecedenceRules] This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataSourceReferenceId

dataSourceReferenceId: undefined | string
member

{string} [dataSourceReferenceId] The data source reference id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataSourceType

dataSourceType: DataSourceType
member

{DataSourceType} [dataSourceType] The data source type. Possible values include: 'Connector', 'LinkInteraction', 'SystemDefault' NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions for the property.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display names for the property.

Optional entityType

entityType: EntityTypes
member

{EntityTypes} [entityType] Type of entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

Optional fields

member

{PropertyDefinition[]} [fields] The properties of the Profile.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional idPropertyNames

idPropertyNames: string[]
member

{string[]} [idPropertyNames] The id property names. Properties which uniquely identify an interaction instance.

Optional instancesCount

instancesCount: undefined | number
member

{number} [instancesCount] The instance count.

Optional interactionResourceFormatId

interactionResourceFormatId: undefined | number
member

{number} [interactionResourceFormatId] The data source ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional interactionResourceFormatName

interactionResourceFormatName: undefined | string
member

{string} [interactionResourceFormatName] The data source name NOTE: This property will not be serialized. It can only be populated by the server.

Optional isActivity

isActivity: undefined | false | true
member

{boolean} [isActivity] An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level.

Optional largeImage

largeImage: undefined | string
member

{string} [largeImage] Large Image associated with the Property or EntityType.

Optional lastChangedUtc

lastChangedUtc: Date
member

{Date} [lastChangedUtc] The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.

Optional localizedAttributes

localizedAttributes: undefined | object
member

{{ [propertyName: string]: { [propertyName: string]: string } }} [localizedAttributes] Any custom localized attributes for the Type.

Optional mediumImage

mediumImage: undefined | string
member

{string} [mediumImage] Medium Image associated with the Property or EntityType.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional participantProfiles

participantProfiles: Participant[]
member

{Participant[]} [participantProfiles] Profiles that participated in the interaction.

Optional primaryParticipantProfilePropertyName

primaryParticipantProfilePropertyName: undefined | string
member

{string} [primaryParticipantProfilePropertyName] The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional schemaItemTypeLink

schemaItemTypeLink: undefined | string
member

{string} [schemaItemTypeLink] The schema org link. This helps ACI identify and suggest semantic models.

Optional smallImage

smallImage: undefined | string
member

{string} [smallImage] Small Image associated with the Property or EntityType.

Optional status

status: Status
member

{Status} [status] The data source status. Possible values include: 'None', 'Active', 'Deleted' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timestampFieldName

timestampFieldName: undefined | string
member

{string} [timestampFieldName] The timestamp property name. Represents the time when the interaction or profile update happened.

Optional typeName

typeName: undefined | string
member

{string} [typeName] The name of the entity.

serializedName

serializedName: string = "InteractionResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "InteractionResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiEntitySetName

apiEntitySetName: object

serializedName

serializedName: string = "properties.apiEntitySetName"

type

type: object

name

name: "String" = "String"

attributes

attributes: object

serializedName

serializedName: string = "properties.attributes"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

dataSourcePrecedenceRules

dataSourcePrecedenceRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.dataSourcePrecedenceRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataSourcePrecedence"

name

name: "Composite" = "Composite"

dataSourceReferenceId

dataSourceReferenceId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultDataSource.dataSourceReferenceId"

type

type: object

name

name: "String" = "String"

dataSourceType

dataSourceType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultDataSource.dataSourceType"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

entityType

entityType: object

serializedName

serializedName: string = "properties.entityType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Profile","Interaction","Relationship"]

name

name: "Enum" = "Enum"

fields

fields: object

serializedName

serializedName: string = "properties.fields"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PropertyDefinition"

name

name: "Composite" = "Composite"

idPropertyNames

idPropertyNames: object

serializedName

serializedName: string = "properties.idPropertyNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

instancesCount

instancesCount: object

serializedName

serializedName: string = "properties.instancesCount"

type

type: object

name

name: "Number" = "Number"

interactionResourceFormatId

interactionResourceFormatId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultDataSource.id"

type

type: object

name

name: "Number" = "Number"

interactionResourceFormatName

interactionResourceFormatName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultDataSource.name"

type

type: object

name

name: "String" = "String"

isActivity

isActivity: object

serializedName

serializedName: string = "properties.isActivity"

type

type: object

name

name: "Boolean" = "Boolean"

largeImage

largeImage: object

serializedName

serializedName: string = "properties.largeImage"

type

type: object

name

name: "String" = "String"

lastChangedUtc

lastChangedUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastChangedUtc"

type

type: object

name

name: "DateTime" = "DateTime"

localizedAttributes

localizedAttributes: object

serializedName

serializedName: string = "properties.localizedAttributes"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

mediumImage

mediumImage: object

serializedName

serializedName: string = "properties.mediumImage"

type

type: object

name

name: "String" = "String"

participantProfiles

participantProfiles: object

serializedName

serializedName: string = "properties.participantProfiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Participant"

name

name: "Composite" = "Composite"

primaryParticipantProfilePropertyName

primaryParticipantProfilePropertyName: object

serializedName

serializedName: string = "properties.primaryParticipantProfilePropertyName"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

schemaItemTypeLink

schemaItemTypeLink: object

serializedName

serializedName: string = "properties.schemaItemTypeLink"

type

type: object

name

name: "String" = "String"

smallImage

smallImage: object

serializedName

serializedName: string = "properties.smallImage"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultDataSource.status"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

timestampFieldName

timestampFieldName: object

serializedName

serializedName: string = "properties.timestampFieldName"

type

type: object

name

name: "String" = "String"

typeName

typeName: object

serializedName

serializedName: string = "properties.typeName"

type

type: object

name

name: "String" = "String"

Const KpiAlias

KpiAlias: object
interface

An interface representing KpiAlias. The KPI alias.

aliasName

aliasName: string
member

{string} aliasName KPI alias name.

expression

expression: string
member

{string} expression The expression.

serializedName

serializedName: string = "KpiAlias"

type

type: object

className

className: string = "KpiAlias"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aliasName

aliasName: object

required

required: true = true

serializedName

serializedName: string = "aliasName"

type

type: object

name

name: "String" = "String"

expression

expression: object

required

required: true = true

serializedName

serializedName: string = "expression"

type

type: object

name

name: "String" = "String"

Const KpiDefinition

KpiDefinition: object
interface

An interface representing KpiDefinition. Defines the KPI Threshold limits.

Optional aliases

aliases: KpiAlias[]
member

{KpiAlias[]} [aliases] The aliases.

calculationWindow

calculationWindow: CalculationWindowTypes
member

{CalculationWindowTypes} calculationWindow The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month'

Optional calculationWindowFieldName

calculationWindowFieldName: undefined | string
member

{string} [calculationWindowFieldName] Name of calculation window field.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized description for the KPI.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the KPI.

entityType

entityType: EntityTypes
member

{EntityTypes} entityType The mapping entity type. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

entityTypeName

entityTypeName: string
member

{string} entityTypeName The mapping entity name.

expression

expression: string
member

{string} expression The computation expression for the KPI.

Optional extracts

extracts: KpiExtract[]
member

{KpiExtract[]} [extracts] The KPI extracts.

Optional filter

filter: undefined | string
member

{string} [filter] The filter expression for the KPI.

functionProperty

functionProperty: KpiFunctions
member

{KpiFunctions} functionProperty The computation function for the KPI. Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', 'None', 'CountDistinct'

Optional groupBy

groupBy: string[]
member

{string[]} [groupBy] the group by properties for the KPI.

Optional groupByMetadata

groupByMetadata: KpiGroupByMetadata[]
member

{KpiGroupByMetadata[]} [groupByMetadata] The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kpiName

kpiName: undefined | string
member

{string} [kpiName] The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional participantProfilesMetadata

participantProfilesMetadata: KpiParticipantProfilesMetadata[]
member

{KpiParticipantProfilesMetadata[]} [participantProfilesMetadata] The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thresHolds

thresHolds: KpiThresholds
member

{KpiThresholds} [thresHolds] The KPI thresholds.

Optional unit

unit: undefined | string
member

{string} [unit] The unit of measurement for the KPI.

serializedName

serializedName: string = "KpiDefinition"

type

type: object

className

className: string = "KpiDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aliases

aliases: object

serializedName

serializedName: string = "aliases"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiAlias"

name

name: "Composite" = "Composite"

calculationWindow

calculationWindow: object

required

required: true = true

serializedName

serializedName: string = "calculationWindow"

type

type: object

allowedValues

allowedValues: string[] = ["Lifetime","Hour","Day","Week","Month"]

name

name: "Enum" = "Enum"

calculationWindowFieldName

calculationWindowFieldName: object

serializedName

serializedName: string = "calculationWindowFieldName"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

entityType

entityType: object

required

required: true = true

serializedName

serializedName: string = "entityType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Profile","Interaction","Relationship"]

name

name: "Enum" = "Enum"

entityTypeName

entityTypeName: object

required

required: true = true

serializedName

serializedName: string = "entityTypeName"

type

type: object

name

name: "String" = "String"

expression

expression: object

required

required: true = true

serializedName

serializedName: string = "expression"

type

type: object

name

name: "String" = "String"

extracts

extracts: object

serializedName

serializedName: string = "extracts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiExtract"

name

name: "Composite" = "Composite"

filter

filter: object

serializedName

serializedName: string = "filter"

type

type: object

name

name: "String" = "String"

functionProperty

functionProperty: object

required

required: true = true

serializedName

serializedName: string = "function"

type

type: object

allowedValues

allowedValues: string[] = ["Sum","Avg","Min","Max","Last","Count","None","CountDistinct"]

name

name: "Enum" = "Enum"

groupBy

groupBy: object

serializedName

serializedName: string = "groupBy"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

groupByMetadata

groupByMetadata: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "groupByMetadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiGroupByMetadata"

name

name: "Composite" = "Composite"

kpiName

kpiName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "kpiName"

type

type: object

name

name: "String" = "String"

participantProfilesMetadata

participantProfilesMetadata: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "participantProfilesMetadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiParticipantProfilesMetadata"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "provisioningState"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

thresHolds

thresHolds: object

serializedName

serializedName: string = "thresHolds"

type

type: object

className

className: string = "KpiThresholds"

name

name: "Composite" = "Composite"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const KpiExtract

KpiExtract: object
interface

An interface representing KpiExtract. The KPI extract.

expression

expression: string
member

{string} expression The expression.

extractName

extractName: string
member

{string} extractName KPI extract name.

serializedName

serializedName: string = "KpiExtract"

type

type: object

className

className: string = "KpiExtract"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expression

expression: object

required

required: true = true

serializedName

serializedName: string = "expression"

type

type: object

name

name: "String" = "String"

extractName

extractName: object

required

required: true = true

serializedName

serializedName: string = "extractName"

type

type: object

name

name: "String" = "String"

Const KpiGroupByMetadata

KpiGroupByMetadata: object
interface

An interface representing KpiGroupByMetadata. The KPI GroupBy field metadata.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] The display name.

Optional fieldName

fieldName: undefined | string
member

{string} [fieldName] The name of the field.

Optional fieldType

fieldType: undefined | string
member

{string} [fieldType] The type of the field.

serializedName

serializedName: string = "KpiGroupByMetadata"

type

type: object

className

className: string = "KpiGroupByMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

fieldName

fieldName: object

serializedName

serializedName: string = "fieldName"

type

type: object

name

name: "String" = "String"

fieldType

fieldType: object

serializedName

serializedName: string = "fieldType"

type

type: object

name

name: "String" = "String"

Const KpiListResult

KpiListResult: object
interface

An interface representing the KpiListResult. The response of list KPI operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "KpiListResult"

__@iterator

  • Iterator

    Returns IterableIterator<KpiResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<KpiResourceFormat>[]

      Additional items to add to the end of array1.

    Returns KpiResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns KpiResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, KpiResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: KpiResourceFormat, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: KpiResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): KpiResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns KpiResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): KpiResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns KpiResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: KpiResourceFormat, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: KpiResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: KpiResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: KpiResourceFormat, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: KpiResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns KpiResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns KpiResourceFormat

  • Parameters

    Returns KpiResourceFormat

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns KpiResourceFormat

  • Parameters

    Returns KpiResourceFormat

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns KpiResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns KpiResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns KpiResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns KpiResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: KpiResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns KpiResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<KpiResourceFormat>

type

type: object

className

className: string = "KpiListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiResourceFormat"

name

name: "Composite" = "Composite"

Const KpiParticipantProfilesMetadata

KpiParticipantProfilesMetadata: object
interface

An interface representing KpiParticipantProfilesMetadata. The KPI participant profile metadata.

typeName

typeName: string
member

{string} typeName Name of the type.

serializedName

serializedName: string = "KpiParticipantProfilesMetadata"

type

type: object

className

className: string = "KpiParticipantProfilesMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

typeName

typeName: object

required

required: true = true

serializedName

serializedName: string = "typeName"

type

type: object

name

name: "String" = "String"

Const KpiResourceFormat

KpiResourceFormat: object
interface

An interface representing KpiResourceFormat. The KPI resource format.

extends

ProxyResource

Optional aliases

aliases: KpiAlias[]
member

{KpiAlias[]} [aliases] The aliases.

calculationWindow

calculationWindow: CalculationWindowTypes
member

{CalculationWindowTypes} calculationWindow The calculation window. Possible values include: 'Lifetime', 'Hour', 'Day', 'Week', 'Month'

Optional calculationWindowFieldName

calculationWindowFieldName: undefined | string
member

{string} [calculationWindowFieldName] Name of calculation window field.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized description for the KPI.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the KPI.

entityType

entityType: EntityTypes
member

{EntityTypes} entityType The mapping entity type. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

entityTypeName

entityTypeName: string
member

{string} entityTypeName The mapping entity name.

expression

expression: string
member

{string} expression The computation expression for the KPI.

Optional extracts

extracts: KpiExtract[]
member

{KpiExtract[]} [extracts] The KPI extracts.

Optional filter

filter: undefined | string
member

{string} [filter] The filter expression for the KPI.

functionProperty

functionProperty: KpiFunctions
member

{KpiFunctions} functionProperty The computation function for the KPI. Possible values include: 'Sum', 'Avg', 'Min', 'Max', 'Last', 'Count', 'None', 'CountDistinct'

Optional groupBy

groupBy: string[]
member

{string[]} [groupBy] the group by properties for the KPI.

Optional groupByMetadata

groupByMetadata: KpiGroupByMetadata[]
member

{KpiGroupByMetadata[]} [groupByMetadata] The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kpiName

kpiName: undefined | string
member

{string} [kpiName] The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional participantProfilesMetadata

participantProfilesMetadata: KpiParticipantProfilesMetadata[]
member

{KpiParticipantProfilesMetadata[]} [participantProfilesMetadata] The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thresHolds

thresHolds: KpiThresholds
member

{KpiThresholds} [thresHolds] The KPI thresholds.

Optional unit

unit: undefined | string
member

{string} [unit] The unit of measurement for the KPI.

serializedName

serializedName: string = "KpiResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "KpiResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aliases

aliases: object

serializedName

serializedName: string = "properties.aliases"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiAlias"

name

name: "Composite" = "Composite"

calculationWindow

calculationWindow: object

required

required: true = true

serializedName

serializedName: string = "properties.calculationWindow"

type

type: object

allowedValues

allowedValues: string[] = ["Lifetime","Hour","Day","Week","Month"]

name

name: "Enum" = "Enum"

calculationWindowFieldName

calculationWindowFieldName: object

serializedName

serializedName: string = "properties.calculationWindowFieldName"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

entityType

entityType: object

required

required: true = true

serializedName

serializedName: string = "properties.entityType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Profile","Interaction","Relationship"]

name

name: "Enum" = "Enum"

entityTypeName

entityTypeName: object

required

required: true = true

serializedName

serializedName: string = "properties.entityTypeName"

type

type: object

name

name: "String" = "String"

expression

expression: object

required

required: true = true

serializedName

serializedName: string = "properties.expression"

type

type: object

name

name: "String" = "String"

extracts

extracts: object

serializedName

serializedName: string = "properties.extracts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiExtract"

name

name: "Composite" = "Composite"

filter

filter: object

serializedName

serializedName: string = "properties.filter"

type

type: object

name

name: "String" = "String"

functionProperty

functionProperty: object

required

required: true = true

serializedName

serializedName: string = "properties.function"

type

type: object

allowedValues

allowedValues: string[] = ["Sum","Avg","Min","Max","Last","Count","None","CountDistinct"]

name

name: "Enum" = "Enum"

groupBy

groupBy: object

serializedName

serializedName: string = "properties.groupBy"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

groupByMetadata

groupByMetadata: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.groupByMetadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiGroupByMetadata"

name

name: "Composite" = "Composite"

kpiName

kpiName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.kpiName"

type

type: object

name

name: "String" = "String"

participantProfilesMetadata

participantProfilesMetadata: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.participantProfilesMetadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KpiParticipantProfilesMetadata"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

thresHolds

thresHolds: object

serializedName

serializedName: string = "properties.thresHolds"

type

type: object

className

className: string = "KpiThresholds"

name

name: "Composite" = "Composite"

unit

unit: object

serializedName

serializedName: string = "properties.unit"

type

type: object

name

name: "String" = "String"

Const KpiThresholds

KpiThresholds: object
interface

An interface representing KpiThresholds. Defines the KPI Threshold limits.

increasingKpi

increasingKpi: boolean
member

{boolean} increasingKpi Whether or not the KPI is an increasing KPI.

lowerLimit

lowerLimit: number
member

{number} lowerLimit The lower threshold limit.

upperLimit

upperLimit: number
member

{number} upperLimit The upper threshold limit.

serializedName

serializedName: string = "KpiThresholds"

type

type: object

className

className: string = "KpiThresholds"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

increasingKpi

increasingKpi: object

required

required: true = true

serializedName

serializedName: string = "increasingKpi"

type

type: object

name

name: "Boolean" = "Boolean"

lowerLimit

lowerLimit: object

required

required: true = true

serializedName

serializedName: string = "lowerLimit"

type

type: object

name

name: "Number" = "Number"

upperLimit

upperLimit: object

required

required: true = true

serializedName

serializedName: string = "upperLimit"

type

type: object

name

name: "Number" = "Number"

Const LinkListResult

LinkListResult: object
interface

An interface representing the LinkListResult. The response of list link operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "LinkListResult"

__@iterator

  • Iterator

    Returns IterableIterator<LinkResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<LinkResourceFormat>[]

      Additional items to add to the end of array1.

    Returns LinkResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LinkResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LinkResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: LinkResourceFormat, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LinkResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LinkResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LinkResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LinkResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns LinkResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LinkResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LinkResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LinkResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns LinkResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LinkResourceFormat

  • Parameters

    Returns LinkResourceFormat

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LinkResourceFormat

  • Parameters

    Returns LinkResourceFormat

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns LinkResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns LinkResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LinkResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LinkResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LinkResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns LinkResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<LinkResourceFormat>

type

type: object

className

className: string = "LinkListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkResourceFormat"

name

name: "Composite" = "Composite"

Const LinkResourceFormat

LinkResourceFormat: object
interface

An interface representing LinkResourceFormat. The link resource format.

extends

ProxyResource

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions for the Link.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the Link.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional linkName

linkName: undefined | string
member

{string} [linkName] The link name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional mappings

member

{TypePropertiesMapping[]} [mappings] The set of properties mappings between the source and target Types.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationType

operationType: InstanceOperationType
member

{InstanceOperationType} [operationType] Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only. Possible values include: 'Upsert', 'Delete'

participantPropertyReferences

participantPropertyReferences: ParticipantPropertyReference[]
member

{ParticipantPropertyReference[]} participantPropertyReferences The properties that represent the participating profile.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional referenceOnly

referenceOnly: undefined | false | true
member

{boolean} [referenceOnly] Indicating whether the link is reference only link. This flag is ingored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.

sourceEntityType

sourceEntityType: EntityType
member

{EntityType} sourceEntityType Type of source entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

sourceEntityTypeName

sourceEntityTypeName: string
member

{string} sourceEntityTypeName Name of the source Entity Type.

targetEntityType

targetEntityType: EntityType
member

{EntityType} targetEntityType Type of target entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

targetEntityTypeName

targetEntityTypeName: string
member

{string} targetEntityTypeName Name of the target Entity Type.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LinkResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "LinkResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

linkName

linkName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.linkName"

type

type: object

name

name: "String" = "String"

mappings

mappings: object

serializedName

serializedName: string = "properties.mappings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TypePropertiesMapping"

name

name: "Composite" = "Composite"

operationType

operationType: object

serializedName

serializedName: string = "properties.operationType"

type

type: object

allowedValues

allowedValues: string[] = ["Upsert","Delete"]

name

name: "Enum" = "Enum"

participantPropertyReferences

participantPropertyReferences: object

required

required: true = true

serializedName

serializedName: string = "properties.participantPropertyReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParticipantPropertyReference"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

referenceOnly

referenceOnly: object

serializedName

serializedName: string = "properties.referenceOnly"

type

type: object

name

name: "Boolean" = "Boolean"

sourceEntityType

sourceEntityType: object

required

required: true = true

serializedName

serializedName: string = "properties.sourceEntityType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Profile","Interaction","Relationship"]

name

name: "Enum" = "Enum"

sourceEntityTypeName

sourceEntityTypeName: object

required

required: true = true

serializedName

serializedName: string = "properties.sourceEntityTypeName"

type

type: object

name

name: "String" = "String"

targetEntityType

targetEntityType: object

required

required: true = true

serializedName

serializedName: string = "properties.targetEntityType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Profile","Interaction","Relationship"]

name

name: "Enum" = "Enum"

targetEntityTypeName

targetEntityTypeName: object

required

required: true = true

serializedName

serializedName: string = "properties.targetEntityTypeName"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

Const MetadataDefinitionBase

MetadataDefinitionBase: object
interface

An interface representing MetadataDefinitionBase. The Metadata definition base.

Optional attributes

attributes: undefined | object
member

{{ [propertyName: string]: string[] }} [attributes] The attributes for the Type.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions for the property.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display names for the property.

Optional largeImage

largeImage: undefined | string
member

{string} [largeImage] Large Image associated with the Property or EntityType.

Optional localizedAttributes

localizedAttributes: undefined | object
member

{{ [propertyName: string]: { [propertyName: string]: string } }} [localizedAttributes] Any custom localized attributes for the Type.

Optional mediumImage

mediumImage: undefined | string
member

{string} [mediumImage] Medium Image associated with the Property or EntityType.

Optional smallImage

smallImage: undefined | string
member

{string} [smallImage] Small Image associated with the Property or EntityType.

serializedName

serializedName: string = "MetadataDefinitionBase"

type

type: object

className

className: string = "MetadataDefinitionBase"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

largeImage

largeImage: object

serializedName

serializedName: string = "largeImage"

type

type: object

name

name: "String" = "String"

localizedAttributes

localizedAttributes: object

serializedName

serializedName: string = "localizedAttributes"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

mediumImage

mediumImage: object

serializedName

serializedName: string = "mediumImage"

type

type: object

name

name: "String" = "String"

smallImage

smallImage: object

serializedName

serializedName: string = "smallImage"

type

type: object

name

name: "String" = "String"

Const Operation

Operation: object
interface

An interface representing Operation. A Customer Insights REST API operation

Optional display

member

{OperationDisplay} [display] The object that represents the operation.

Optional name

name: undefined | string
member

{string} [name] Operation name: {provider}/{resource}/{operation} NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const OperationDisplay

OperationDisplay: object
interface

An interface representing OperationDisplay. The object that represents the operation.

Optional operation

operation: undefined | string
member

{string} [operation] Operation type: Read, write, delete, etc. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provider

provider: undefined | string
member

{string} [provider] Service provider: Microsoft.CustomerInsights NOTE: This property will not be serialized. It can only be populated by the server.

Optional resource

resource: undefined | string
member

{string} [resource] Resource on which the operation is performed: Invoice, etc. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operation

operation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationListResult

OperationListResult: object
interface

An interface representing the OperationListResult. Result of the request to list Customer Insights operations. It contains a list of operations and a URL link to get the next set of results.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] URL to get the next set of operation list results if there are any. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "OperationListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const Participant

Participant: object
interface

An interface representing Participant. Describes a profile type participating in an interaction.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name.

participantName

participantName: string
member

{string} participantName Participant name.

participantPropertyReferences

participantPropertyReferences: ParticipantPropertyReference[]
member

{ParticipantPropertyReference[]} participantPropertyReferences The property references.

profileTypeName

profileTypeName: string
member

{string} profileTypeName Profile type name.

Optional role

role: undefined | string
member

{string} [role] The role that the participant is playing in the interaction.

serializedName

serializedName: string = "Participant"

type

type: object

className

className: string = "Participant"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

participantName

participantName: object

required

required: true = true

serializedName

serializedName: string = "participantName"

type

type: object

name

name: "String" = "String"

participantPropertyReferences

participantPropertyReferences: object

required

required: true = true

serializedName

serializedName: string = "participantPropertyReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParticipantPropertyReference"

name

name: "Composite" = "Composite"

profileTypeName

profileTypeName: object

required

required: true = true

serializedName

serializedName: string = "profileTypeName"

type

type: object

name

name: "String" = "String"

role

role: object

serializedName

serializedName: string = "role"

type

type: object

name

name: "String" = "String"

Const ParticipantProfilePropertyReference

ParticipantProfilePropertyReference: object
interface

An interface representing ParticipantProfilePropertyReference. The participant profile property reference.

interactionPropertyName

interactionPropertyName: string
member

{string} interactionPropertyName The source interaction property that maps to the target profile property.

profilePropertyName

profilePropertyName: string
member

{string} profilePropertyName The target profile property that maps to the source interaction property.

serializedName

serializedName: string = "ParticipantProfilePropertyReference"

type

type: object

className

className: string = "ParticipantProfilePropertyReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

interactionPropertyName

interactionPropertyName: object

required

required: true = true

serializedName

serializedName: string = "interactionPropertyName"

type

type: object

name

name: "String" = "String"

profilePropertyName

profilePropertyName: object

required

required: true = true

serializedName

serializedName: string = "profilePropertyName"

type

type: object

name

name: "String" = "String"

Const ParticipantPropertyReference

ParticipantPropertyReference: object
interface

An interface representing ParticipantPropertyReference. The participant property reference.

sourcePropertyName

sourcePropertyName: string
member

{string} sourcePropertyName The source property that maps to the target property.

targetPropertyName

targetPropertyName: string
member

{string} targetPropertyName The target property that maps to the source property.

serializedName

serializedName: string = "ParticipantPropertyReference"

type

type: object

className

className: string = "ParticipantPropertyReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

sourcePropertyName

sourcePropertyName: object

required

required: true = true

serializedName

serializedName: string = "sourcePropertyName"

type

type: object

name

name: "String" = "String"

targetPropertyName

targetPropertyName: object

required

required: true = true

serializedName

serializedName: string = "targetPropertyName"

type

type: object

name

name: "String" = "String"

Const PredictionDistributionDefinition

PredictionDistributionDefinition: object
interface

An interface representing PredictionDistributionDefinition. The definition of the prediction distribution.

Optional distributions

member

{PredictionDistributionDefinitionDistributionsItem[]} [distributions] Distributions of the prediction.

Optional totalNegatives

totalNegatives: undefined | number
member

{number} [totalNegatives] Total negatives in the distribution.

Optional totalPositives

totalPositives: undefined | number
member

{number} [totalPositives] Total positive in the distribution.

serializedName

serializedName: string = "PredictionDistributionDefinition"

type

type: object

className

className: string = "PredictionDistributionDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

distributions

distributions: object

serializedName

serializedName: string = "distributions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PredictionDistributionDefinitionDistributionsItem"

name

name: "Composite" = "Composite"

totalNegatives

totalNegatives: object

serializedName

serializedName: string = "totalNegatives"

type

type: object

name

name: "Number" = "Number"

totalPositives

totalPositives: object

serializedName

serializedName: string = "totalPositives"

type

type: object

name

name: "Number" = "Number"

Const PredictionDistributionDefinitionDistributionsItem

PredictionDistributionDefinitionDistributionsItem: object
interface

An interface representing PredictionDistributionDefinitionDistributionsItem. The definition of a prediction distribution.

Optional negatives

negatives: undefined | number
member

{number} [negatives] Number of negatives.

Optional negativesAboveThreshold

negativesAboveThreshold: undefined | number
member

{number} [negativesAboveThreshold] Number of negatives above threshold.

Optional positives

positives: undefined | number
member

{number} [positives] Number of positives.

Optional positivesAboveThreshold

positivesAboveThreshold: undefined | number
member

{number} [positivesAboveThreshold] Number of positives above threshold.

Optional scoreThreshold

scoreThreshold: undefined | number
member

{number} [scoreThreshold] Score threshold.

serializedName

serializedName: string = "PredictionDistributionDefinition_distributionsItem"

type

type: object

className

className: string = "PredictionDistributionDefinitionDistributionsItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

negatives

negatives: object

serializedName

serializedName: string = "negatives"

type

type: object

name

name: "Number" = "Number"

negativesAboveThreshold

negativesAboveThreshold: object

serializedName

serializedName: string = "negativesAboveThreshold"

type

type: object

name

name: "Number" = "Number"

positives

positives: object

serializedName

serializedName: string = "positives"

type

type: object

name

name: "Number" = "Number"

positivesAboveThreshold

positivesAboveThreshold: object

serializedName

serializedName: string = "positivesAboveThreshold"

type

type: object

name

name: "Number" = "Number"

scoreThreshold

scoreThreshold: object

serializedName

serializedName: string = "scoreThreshold"

type

type: object

name

name: "Number" = "Number"

Const PredictionGradesItem

PredictionGradesItem: object
interface

An interface representing PredictionGradesItem. The definition of a prediction grade.

Optional gradeName

gradeName: undefined | string
member

{string} [gradeName] Name of the grade.

Optional maxScoreThreshold

maxScoreThreshold: undefined | number
member

{number} [maxScoreThreshold] Maximum score threshold.

Optional minScoreThreshold

minScoreThreshold: undefined | number
member

{number} [minScoreThreshold] Minimum score threshold.

serializedName

serializedName: string = "Prediction_gradesItem"

type

type: object

className

className: string = "PredictionGradesItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

gradeName

gradeName: object

serializedName

serializedName: string = "gradeName"

type

type: object

name

name: "String" = "String"

maxScoreThreshold

maxScoreThreshold: object

serializedName

serializedName: string = "maxScoreThreshold"

type

type: object

name

name: "Number" = "Number"

minScoreThreshold

minScoreThreshold: object

serializedName

serializedName: string = "minScoreThreshold"

type

type: object

name

name: "Number" = "Number"

Const PredictionListResult

PredictionListResult: object
interface

An interface representing the PredictionListResult. The response of list predictions operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "PredictionListResult"

__@iterator

  • Iterator

    Returns IterableIterator<PredictionResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns PredictionResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PredictionResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PredictionResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PredictionResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PredictionResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PredictionResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PredictionResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns PredictionResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PredictionResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PredictionResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PredictionResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns PredictionResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns PredictionResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns PredictionResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PredictionResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PredictionResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PredictionResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns PredictionResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<PredictionResourceFormat>

type

type: object

className

className: string = "PredictionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PredictionResourceFormat"

name

name: "Composite" = "Composite"

Const PredictionMappings

PredictionMappings: object
interface

An interface representing PredictionMappings. Definition of the link mapping of prediction.

grade

grade: string
member

{string} grade The grade of the link mapping.

reason

reason: string
member

{string} reason The reason of the link mapping.

score

score: string
member

{string} score The score of the link mapping.

serializedName

serializedName: string = "Prediction_mappings"

type

type: object

className

className: string = "PredictionMappings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

grade

grade: object

required

required: true = true

serializedName

serializedName: string = "grade"

type

type: object

name

name: "String" = "String"

reason

reason: object

required

required: true = true

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

score

score: object

required

required: true = true

serializedName

serializedName: string = "score"

type

type: object

name

name: "String" = "String"

Const PredictionModelStatus

PredictionModelStatus: object
interface

An interface representing PredictionModelStatus. The prediction model status.

Optional message

message: undefined | string
member

{string} [message] The model status message. NOTE: This property will not be serialized. It can only be populated by the server.

Optional modelVersion

modelVersion: undefined | string
member

{string} [modelVersion] Version of the model. NOTE: This property will not be serialized. It can only be populated by the server.

Optional predictionGuidId

predictionGuidId: undefined | string
member

{string} [predictionGuidId] The prediction GUID ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional predictionName

predictionName: undefined | string
member

{string} [predictionName] The prediction name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional signalsUsed

signalsUsed: undefined | number
member

{number} [signalsUsed] The singnas used. NOTE: This property will not be serialized. It can only be populated by the server.

status

member

{PredictionModelLifeCycle} status Prediction model life cycle. When prediction is in PendingModelConfirmation status, it is allowed to update the status to PendingFeaturing or Active through API. Possible values include: 'New', 'Provisioning', 'ProvisioningFailed', 'PendingDiscovering', 'Discovering', 'PendingFeaturing', 'Featuring', 'FeaturingFailed', 'PendingTraining', 'Training', 'TrainingFailed', 'Evaluating', 'EvaluatingFailed', 'PendingModelConfirmation', 'Active', 'Deleted', 'HumanIntervention', 'Failed'

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional testSetCount

testSetCount: undefined | number
member

{number} [testSetCount] Count of the test set. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trainingAccuracy

trainingAccuracy: undefined | number
member

{number} [trainingAccuracy] The training accuracy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trainingSetCount

trainingSetCount: undefined | number
member

{number} [trainingSetCount] Count of the training set. NOTE: This property will not be serialized. It can only be populated by the server.

Optional validationSetCount

validationSetCount: undefined | number
member

{number} [validationSetCount] Count of the validation set. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PredictionModelStatus"

type

type: object

className

className: string = "PredictionModelStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

modelVersion

modelVersion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "modelVersion"

type

type: object

name

name: "String" = "String"

predictionGuidId

predictionGuidId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "predictionGuidId"

type

type: object

name

name: "String" = "String"

predictionName

predictionName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "predictionName"

type

type: object

name

name: "String" = "String"

signalsUsed

signalsUsed: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "signalsUsed"

type

type: object

name

name: "Number" = "Number"

status

status: object

required

required: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

testSetCount

testSetCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "testSetCount"

type

type: object

name

name: "Number" = "Number"

trainingAccuracy

trainingAccuracy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "trainingAccuracy"

type

type: object

name

name: "Number" = "Number"

trainingSetCount

trainingSetCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "trainingSetCount"

type

type: object

name

name: "Number" = "Number"

validationSetCount

validationSetCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "validationSetCount"

type

type: object

name

name: "Number" = "Number"

Const PredictionResourceFormat

PredictionResourceFormat: object
interface

An interface representing PredictionResourceFormat. The prediction resource format.

extends

ProxyResource

autoAnalyze

autoAnalyze: boolean
member

{boolean} autoAnalyze Whether do auto analyze.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Description of the prediction.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Display name of the prediction.

Optional grades

member

{PredictionGradesItem[]} [grades] The prediction grades.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional involvedInteractionTypes

involvedInteractionTypes: string[]
member

{string[]} [involvedInteractionTypes] Interaction types involved in the prediction.

Optional involvedKpiTypes

involvedKpiTypes: string[]
member

{string[]} [involvedKpiTypes] KPI types involved in the prediction.

Optional involvedRelationships

involvedRelationships: string[]
member

{string[]} [involvedRelationships] Relationships involved in the prediction.

mappings

member

{PredictionMappings} mappings Definition of the link mapping of prediction.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

negativeOutcomeExpression

negativeOutcomeExpression: string
member

{string} negativeOutcomeExpression Negative outcome expression.

positiveOutcomeExpression

positiveOutcomeExpression: string
member

{string} positiveOutcomeExpression Positive outcome expression.

Optional predictionName

predictionName: undefined | string
member

{string} [predictionName] Name of the prediction.

primaryProfileType

primaryProfileType: string
member

{string} primaryProfileType Primary profile type.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

scopeExpression

scopeExpression: string
member

{string} scopeExpression Scope expression.

scoreLabel

scoreLabel: string
member

{string} scoreLabel Score label.

Optional systemGeneratedEntities

systemGeneratedEntities: PredictionSystemGeneratedEntities
member

{PredictionSystemGeneratedEntities} [systemGeneratedEntities] System generated entities. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PredictionResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PredictionResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoAnalyze

autoAnalyze: object

required

required: true = true

serializedName

serializedName: string = "properties.autoAnalyze"

type

type: object

name

name: "Boolean" = "Boolean"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

grades

grades: object

serializedName

serializedName: string = "properties.grades"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PredictionGradesItem"

name

name: "Composite" = "Composite"

involvedInteractionTypes

involvedInteractionTypes: object

serializedName

serializedName: string = "properties.involvedInteractionTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

involvedKpiTypes

involvedKpiTypes: object

serializedName

serializedName: string = "properties.involvedKpiTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

involvedRelationships

involvedRelationships: object

serializedName

serializedName: string = "properties.involvedRelationships"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

mappings

mappings: object

required

required: true = true

serializedName

serializedName: string = "properties.mappings"

type

type: object

className

className: string = "PredictionMappings"

name

name: "Composite" = "Composite"

negativeOutcomeExpression

negativeOutcomeExpression: object

required

required: true = true

serializedName

serializedName: string = "properties.negativeOutcomeExpression"

type

type: object

name

name: "String" = "String"

positiveOutcomeExpression

positiveOutcomeExpression: object

required

required: true = true

serializedName

serializedName: string = "properties.positiveOutcomeExpression"

type

type: object

name

name: "String" = "String"

predictionName

predictionName: object

serializedName

serializedName: string = "properties.predictionName"

type

type: object

name

name: "String" = "String"

primaryProfileType

primaryProfileType: object

required

required: true = true

serializedName

serializedName: string = "properties.primaryProfileType"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

scopeExpression

scopeExpression: object

required

required: true = true

serializedName

serializedName: string = "properties.scopeExpression"

type

type: object

name

name: "String" = "String"

scoreLabel

scoreLabel: object

required

required: true = true

serializedName

serializedName: string = "properties.scoreLabel"

type

type: object

name

name: "String" = "String"

systemGeneratedEntities

systemGeneratedEntities: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.systemGeneratedEntities"

type

type: object

className

className: string = "PredictionSystemGeneratedEntities"

name

name: "Composite" = "Composite"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

Const PredictionSystemGeneratedEntities

PredictionSystemGeneratedEntities: object
interface

An interface representing PredictionSystemGeneratedEntities. System generated entities.

Optional generatedInteractionTypes

generatedInteractionTypes: string[]
member

{string[]} [generatedInteractionTypes] Generated interaction types.

Optional generatedKpis

generatedKpis: undefined | object
member

{{ [propertyName: string]: string }} [generatedKpis] Generated KPIs.

Optional generatedLinks

generatedLinks: string[]
member

{string[]} [generatedLinks] Generated links.

serializedName

serializedName: string = "Prediction_systemGeneratedEntities"

type

type: object

className

className: string = "PredictionSystemGeneratedEntities"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

generatedInteractionTypes

generatedInteractionTypes: object

serializedName

serializedName: string = "generatedInteractionTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

generatedKpis

generatedKpis: object

serializedName

serializedName: string = "generatedKpis"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

generatedLinks

generatedLinks: object

serializedName

serializedName: string = "generatedLinks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const PredictionTrainingResults

PredictionTrainingResults: object
interface

An interface representing PredictionTrainingResults. The training results of the prediction.

Optional canonicalProfiles

canonicalProfiles: CanonicalProfileDefinition[]
member

{CanonicalProfileDefinition[]} [canonicalProfiles] Canonical profiles. NOTE: This property will not be serialized. It can only be populated by the server.

Optional predictionDistribution

predictionDistribution: PredictionDistributionDefinition
member

{PredictionDistributionDefinition} [predictionDistribution] Prediction distribution. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryProfileInstanceCount

primaryProfileInstanceCount: undefined | number
member

{number} [primaryProfileInstanceCount] Instance count of the primary profile. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scoreName

scoreName: undefined | string
member

{string} [scoreName] Score name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PredictionTrainingResults"

type

type: object

className

className: string = "PredictionTrainingResults"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

canonicalProfiles

canonicalProfiles: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "canonicalProfiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CanonicalProfileDefinition"

name

name: "Composite" = "Composite"

predictionDistribution

predictionDistribution: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "predictionDistribution"

type

type: object

className

className: string = "PredictionDistributionDefinition"

name

name: "Composite" = "Composite"

primaryProfileInstanceCount

primaryProfileInstanceCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "primaryProfileInstanceCount"

type

type: object

name

name: "Number" = "Number"

scoreName

scoreName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "scoreName"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

Const ProfileEnumValidValuesFormat

ProfileEnumValidValuesFormat: object
interface

An interface representing ProfileEnumValidValuesFormat. Valid enum values in case of an enum property.

Optional localizedValueNames

localizedValueNames: undefined | object
member

{{ [propertyName: string]: string }} [localizedValueNames] Localized names of the enum member.

Optional value

value: undefined | number
member

{number} [value] The integer value of the enum member.

serializedName

serializedName: string = "ProfileEnumValidValuesFormat"

type

type: object

className

className: string = "ProfileEnumValidValuesFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValueNames

localizedValueNames: object

serializedName

serializedName: string = "localizedValueNames"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Number" = "Number"

Const ProfileListResult

ProfileListResult: object
interface

An interface representing the ProfileListResult. The response of list profile operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "ProfileListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ProfileResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns ProfileResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProfileResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProfileResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProfileResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProfileResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProfileResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProfileResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ProfileResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProfileResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProfileResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProfileResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ProfileResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ProfileResourceFormat

  • Parameters

    Returns ProfileResourceFormat

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ProfileResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns ProfileResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProfileResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProfileResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProfileResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProfileResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ProfileResourceFormat>

type

type: object

className

className: string = "ProfileListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProfileResourceFormat"

name

name: "Composite" = "Composite"

Const ProfileResourceFormat

ProfileResourceFormat: object
interface

An interface representing ProfileResourceFormat. The profile resource format.

extends

ProxyResource

Optional apiEntitySetName

apiEntitySetName: undefined | string
member

{string} [apiEntitySetName] The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object.

Optional attributes

attributes: undefined | object
member

{{ [propertyName: string]: string[] }} [attributes] The attributes for the Type.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions for the property.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display names for the property.

Optional entityType

entityType: EntityTypes
member

{EntityTypes} [entityType] Type of entity. Possible values include: 'None', 'Profile', 'Interaction', 'Relationship'

Optional fields

member

{PropertyDefinition[]} [fields] The properties of the Profile.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional instancesCount

instancesCount: undefined | number
member

{number} [instancesCount] The instance count.

Optional largeImage

largeImage: undefined | string
member

{string} [largeImage] Large Image associated with the Property or EntityType.

Optional lastChangedUtc

lastChangedUtc: Date
member

{Date} [lastChangedUtc] The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.

Optional localizedAttributes

localizedAttributes: undefined | object
member

{{ [propertyName: string]: { [propertyName: string]: string } }} [localizedAttributes] Any custom localized attributes for the Type.

Optional mediumImage

mediumImage: undefined | string
member

{string} [mediumImage] Medium Image associated with the Property or EntityType.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional schemaItemTypeLink

schemaItemTypeLink: undefined | string
member

{string} [schemaItemTypeLink] The schema org link. This helps ACI identify and suggest semantic models.

Optional smallImage

smallImage: undefined | string
member

{string} [smallImage] Small Image associated with the Property or EntityType.

Optional strongIds

strongIds: StrongId[]
member

{StrongId[]} [strongIds] The strong IDs.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timestampFieldName

timestampFieldName: undefined | string
member

{string} [timestampFieldName] The timestamp property name. Represents the time when the interaction or profile update happened.

Optional typeName

typeName: undefined | string
member

{string} [typeName] The name of the entity.

serializedName

serializedName: string = "ProfileResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProfileResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiEntitySetName

apiEntitySetName: object

serializedName

serializedName: string = "properties.apiEntitySetName"

type

type: object

name

name: "String" = "String"

attributes

attributes: object

serializedName

serializedName: string = "properties.attributes"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

entityType

entityType: object

serializedName

serializedName: string = "properties.entityType"

type

type: object

allowedValues

allowedValues: string[] = ["None","Profile","Interaction","Relationship"]

name

name: "Enum" = "Enum"

fields

fields: object

serializedName

serializedName: string = "properties.fields"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PropertyDefinition"

name

name: "Composite" = "Composite"

instancesCount

instancesCount: object

serializedName

serializedName: string = "properties.instancesCount"

type

type: object

name

name: "Number" = "Number"

largeImage

largeImage: object

serializedName

serializedName: string = "properties.largeImage"

type

type: object

name

name: "String" = "String"

lastChangedUtc

lastChangedUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastChangedUtc"

type

type: object

name

name: "DateTime" = "DateTime"

localizedAttributes

localizedAttributes: object

serializedName

serializedName: string = "properties.localizedAttributes"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

mediumImage

mediumImage: object

serializedName

serializedName: string = "properties.mediumImage"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

schemaItemTypeLink

schemaItemTypeLink: object

serializedName

serializedName: string = "properties.schemaItemTypeLink"

type

type: object

name

name: "String" = "String"

smallImage

smallImage: object

serializedName

serializedName: string = "properties.smallImage"

type

type: object

name

name: "String" = "String"

strongIds

strongIds: object

serializedName

serializedName: string = "properties.strongIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StrongId"

name

name: "Composite" = "Composite"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

timestampFieldName

timestampFieldName: object

serializedName

serializedName: string = "properties.timestampFieldName"

type

type: object

name

name: "String" = "String"

typeName

typeName: object

serializedName

serializedName: string = "properties.typeName"

type

type: object

name

name: "String" = "String"

Const PropertyDefinition

PropertyDefinition: object
interface

An interface representing PropertyDefinition. Property definition.

Optional arrayValueSeparator

arrayValueSeparator: undefined | string
member

{string} [arrayValueSeparator] Array value separator for properties with isArray set.

Optional dataSourcePrecedenceRules

dataSourcePrecedenceRules: DataSourcePrecedence[]
member

{DataSourcePrecedence[]} [dataSourcePrecedenceRules] This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enumValidValues

enumValidValues: ProfileEnumValidValuesFormat[]
member

{ProfileEnumValidValuesFormat[]} [enumValidValues] Describes valid values for an enum property.

fieldName

fieldName: string
member

{string} fieldName Name of the property.

fieldType

fieldType: string
member

{string} fieldType Type of the property.

Optional isArray

isArray: undefined | false | true
member

{boolean} [isArray] Indicates if the property is actually an array of the fieldType above on the data api.

Optional isAvailableInGraph

isAvailableInGraph: undefined | false | true
member

{boolean} [isAvailableInGraph] Whether property is available in graph or not.

Optional isEnum

isEnum: undefined | false | true
member

{boolean} [isEnum] Indicates if the property is an enum.

Optional isFlagEnum

isFlagEnum: undefined | false | true
member

{boolean} [isFlagEnum] Indicates if the property is an flag enum.

Optional isImage

isImage: undefined | false | true
member

{boolean} [isImage] Whether the property is an Image.

Optional isLocalizedString

isLocalizedString: undefined | false | true
member

{boolean} [isLocalizedString] Whether the property is a localized string.

Optional isName

isName: undefined | false | true
member

{boolean} [isName] Whether the property is a name or a part of name.

Optional isRequired

isRequired: undefined | false | true
member

{boolean} [isRequired] Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field.

Optional maxLength

maxLength: undefined | number
member

{number} [maxLength] Max length of string. Used only if type is string.

Optional propertyId

propertyId: undefined | string
member

{string} [propertyId] The ID associated with the property.

Optional schemaItemPropLink

schemaItemPropLink: undefined | string
member

{string} [schemaItemPropLink] URL encoded schema.org item prop link for the property.

serializedName

serializedName: string = "PropertyDefinition"

type

type: object

className

className: string = "PropertyDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

arrayValueSeparator

arrayValueSeparator: object

serializedName

serializedName: string = "arrayValueSeparator"

type

type: object

name

name: "String" = "String"

dataSourcePrecedenceRules

dataSourcePrecedenceRules: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataSourcePrecedenceRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataSourcePrecedence"

name

name: "Composite" = "Composite"

enumValidValues

enumValidValues: object

serializedName

serializedName: string = "enumValidValues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProfileEnumValidValuesFormat"

name

name: "Composite" = "Composite"

fieldName

fieldName: object

required

required: true = true

serializedName

serializedName: string = "fieldName"

type

type: object

name

name: "String" = "String"

fieldType

fieldType: object

required

required: true = true

serializedName

serializedName: string = "fieldType"

type

type: object

name

name: "String" = "String"

isArray

isArray: object

serializedName

serializedName: string = "isArray"

type

type: object

name

name: "Boolean" = "Boolean"

isAvailableInGraph

isAvailableInGraph: object

serializedName

serializedName: string = "isAvailableInGraph"

type

type: object

name

name: "Boolean" = "Boolean"

isEnum

isEnum: object

serializedName

serializedName: string = "isEnum"

type

type: object

name

name: "Boolean" = "Boolean"

isFlagEnum

isFlagEnum: object

serializedName

serializedName: string = "isFlagEnum"

type

type: object

name

name: "Boolean" = "Boolean"

isImage

isImage: object

serializedName

serializedName: string = "isImage"

type

type: object

name

name: "Boolean" = "Boolean"

isLocalizedString

isLocalizedString: object

serializedName

serializedName: string = "isLocalizedString"

type

type: object

name

name: "Boolean" = "Boolean"

isName

isName: object

serializedName

serializedName: string = "isName"

type

type: object

name

name: "Boolean" = "Boolean"

isRequired

isRequired: object

serializedName

serializedName: string = "isRequired"

type

type: object

name

name: "Boolean" = "Boolean"

maxLength

maxLength: object

serializedName

serializedName: string = "maxLength"

type

type: object

name

name: "Number" = "Number"

propertyId

propertyId: object

serializedName

serializedName: string = "propertyId"

type

type: object

name

name: "String" = "String"

schemaItemPropLink

schemaItemPropLink: object

serializedName

serializedName: string = "schemaItemPropLink"

type

type: object

name

name: "String" = "String"

Const ProxyResource

ProxyResource: object
interface

An interface representing ProxyResource. Common properties of proxy resource.

extends

BaseResource

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProxyResource"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProxyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const RelationshipLinkFieldMapping

RelationshipLinkFieldMapping: object
interface

An interface representing RelationshipLinkFieldMapping. The fields mapping for Relationships.

interactionFieldName

interactionFieldName: string
member

{string} interactionFieldName The field name on the Interaction Type.

Optional linkType

linkType: LinkTypes
member

{LinkTypes} [linkType] Link type. Possible values include: 'UpdateAlways', 'CopyIfNull'

relationshipFieldName

relationshipFieldName: string
member

{string} relationshipFieldName The field name on the Relationship metadata.

serializedName

serializedName: string = "RelationshipLinkFieldMapping"

type

type: object

className

className: string = "RelationshipLinkFieldMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

interactionFieldName

interactionFieldName: object

required

required: true = true

serializedName

serializedName: string = "interactionFieldName"

type

type: object

name

name: "String" = "String"

linkType

linkType: object

serializedName

serializedName: string = "linkType"

type

type: object

allowedValues

allowedValues: string[] = ["UpdateAlways","CopyIfNull"]

name

name: "Enum" = "Enum"

relationshipFieldName

relationshipFieldName: object

required

required: true = true

serializedName

serializedName: string = "relationshipFieldName"

type

type: object

name

name: "String" = "String"

Const RelationshipLinkListResult

RelationshipLinkListResult: object
interface

An interface representing the RelationshipLinkListResult. The response of list relationship link operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "RelationshipLinkListResult"

__@iterator

  • Iterator

    Returns IterableIterator<RelationshipLinkResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns RelationshipLinkResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RelationshipLinkResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RelationshipLinkResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RelationshipLinkResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns RelationshipLinkResourceFormat[]

find

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RelationshipLinkResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RelationshipLinkResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RelationshipLinkResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RelationshipLinkResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns RelationshipLinkResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns RelationshipLinkResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RelationshipLinkResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RelationshipLinkResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RelationshipLinkResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns RelationshipLinkResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RelationshipLinkResourceFormat>

type

type: object

className

className: string = "RelationshipLinkListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RelationshipLinkResourceFormat"

name

name: "Composite" = "Composite"

Const RelationshipLinkResourceFormat

RelationshipLinkResourceFormat: object
interface

An interface representing RelationshipLinkResourceFormat. The relationship link resource format.

extends

ProxyResource

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions for the Relationship Link.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the Relationship Link.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

interactionType

interactionType: string
member

{string} interactionType The InteractionType associated with the Relationship Link.

Optional linkName

linkName: undefined | string
member

{string} [linkName] The name of the Relationship Link. NOTE: This property will not be serialized. It can only be populated by the server.

Optional mappings

member

{RelationshipLinkFieldMapping[]} [mappings] The mappings between Interaction and Relationship fields.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

profilePropertyReferences

profilePropertyReferences: ParticipantProfilePropertyReference[]
member

{ParticipantProfilePropertyReference[]} profilePropertyReferences The property references for the Profile of the Relationship.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

relatedProfilePropertyReferences

relatedProfilePropertyReferences: ParticipantProfilePropertyReference[]
member

{ParticipantProfilePropertyReference[]} relatedProfilePropertyReferences The property references for the Related Profile of the Relationship.

Optional relationshipGuidId

relationshipGuidId: undefined | string
member

{string} [relationshipGuidId] The relationship guid id. NOTE: This property will not be serialized. It can only be populated by the server.

relationshipName

relationshipName: string
member

{string} relationshipName The Relationship associated with the Link.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RelationshipLinkResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RelationshipLinkResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

interactionType

interactionType: object

required

required: true = true

serializedName

serializedName: string = "properties.interactionType"

type

type: object

name

name: "String" = "String"

linkName

linkName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.linkName"

type

type: object

name

name: "String" = "String"

mappings

mappings: object

serializedName

serializedName: string = "properties.mappings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RelationshipLinkFieldMapping"

name

name: "Composite" = "Composite"

profilePropertyReferences

profilePropertyReferences: object

required

required: true = true

serializedName

serializedName: string = "properties.profilePropertyReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParticipantProfilePropertyReference"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

relatedProfilePropertyReferences

relatedProfilePropertyReferences: object

required

required: true = true

serializedName

serializedName: string = "properties.relatedProfilePropertyReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParticipantProfilePropertyReference"

name

name: "Composite" = "Composite"

relationshipGuidId

relationshipGuidId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.relationshipGuidId"

type

type: object

name

name: "String" = "String"

relationshipName

relationshipName: object

required

required: true = true

serializedName

serializedName: string = "properties.relationshipName"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

Const RelationshipListResult

RelationshipListResult: object
interface

An interface representing the RelationshipListResult. The response of list relationship operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "RelationshipListResult"

__@iterator

  • Iterator

    Returns IterableIterator<RelationshipResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns RelationshipResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RelationshipResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RelationshipResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RelationshipResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns RelationshipResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RelationshipResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RelationshipResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RelationshipResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RelationshipResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RelationshipResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RelationshipResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns RelationshipResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns RelationshipResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RelationshipResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RelationshipResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RelationshipResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns RelationshipResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RelationshipResourceFormat>

type

type: object

className

className: string = "RelationshipListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RelationshipResourceFormat"

name

name: "Composite" = "Composite"

Const RelationshipResourceFormat

RelationshipResourceFormat: object
interface

An interface representing RelationshipResourceFormat. The relationship resource format.

extends

ProxyResource

Optional cardinality

cardinality: CardinalityTypes
member

{CardinalityTypes} [cardinality] The Relationship Cardinality. Possible values include: 'OneToOne', 'OneToMany', 'ManyToMany'

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions for the Relationship.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the Relationship.

Optional expiryDateTimeUtc

expiryDateTimeUtc: Date
member

{Date} [expiryDateTimeUtc] The expiry date time in UTC.

Optional fields

member

{PropertyDefinition[]} [fields] The properties of the Relationship.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lookupMappings

lookupMappings: RelationshipTypeMapping[]
member

{RelationshipTypeMapping[]} [lookupMappings] Optional property to be used to map fields in profile to their strong ids in related profile.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

profileType

profileType: string
member

{string} profileType Profile type.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

relatedProfileType

relatedProfileType: string
member

{string} relatedProfileType Related profile being referenced.

Optional relationshipGuidId

relationshipGuidId: undefined | string
member

{string} [relationshipGuidId] The relationship guid id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional relationshipName

relationshipName: undefined | string
member

{string} [relationshipName] The Relationship name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RelationshipResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RelationshipResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cardinality

cardinality: object

serializedName

serializedName: string = "properties.cardinality"

type

type: object

allowedValues

allowedValues: string[] = ["OneToOne","OneToMany","ManyToMany"]

name

name: "Enum" = "Enum"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

expiryDateTimeUtc

expiryDateTimeUtc: object

serializedName

serializedName: string = "properties.expiryDateTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

fields

fields: object

serializedName

serializedName: string = "properties.fields"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PropertyDefinition"

name

name: "Composite" = "Composite"

lookupMappings

lookupMappings: object

serializedName

serializedName: string = "properties.lookupMappings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RelationshipTypeMapping"

name

name: "Composite" = "Composite"

profileType

profileType: object

required

required: true = true

serializedName

serializedName: string = "properties.profileType"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

relatedProfileType

relatedProfileType: object

required

required: true = true

serializedName

serializedName: string = "properties.relatedProfileType"

type

type: object

name

name: "String" = "String"

relationshipGuidId

relationshipGuidId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.relationshipGuidId"

type

type: object

name

name: "String" = "String"

relationshipName

relationshipName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.relationshipName"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

Const RelationshipTypeFieldMapping

RelationshipTypeFieldMapping: object
interface

An interface representing RelationshipTypeFieldMapping. Map a field of profile to its corresponding StrongId in Related Profile.

profileFieldName

profileFieldName: string
member

{string} profileFieldName Specifies the fieldName in profile.

relatedProfileKeyProperty

relatedProfileKeyProperty: string
member

{string} relatedProfileKeyProperty Specifies the KeyProperty (from StrongId) of the related profile.

serializedName

serializedName: string = "RelationshipTypeFieldMapping"

type

type: object

className

className: string = "RelationshipTypeFieldMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

profileFieldName

profileFieldName: object

required

required: true = true

serializedName

serializedName: string = "profileFieldName"

type

type: object

name

name: "String" = "String"

relatedProfileKeyProperty

relatedProfileKeyProperty: object

required

required: true = true

serializedName

serializedName: string = "relatedProfileKeyProperty"

type

type: object

name

name: "String" = "String"

Const RelationshipTypeMapping

RelationshipTypeMapping: object
interface

An interface representing RelationshipTypeMapping. Maps fields in Profile to their corresponding StrongIds in Related Profile.

fieldMappings

member

{RelationshipTypeFieldMapping[]} fieldMappings Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.

serializedName

serializedName: string = "RelationshipTypeMapping"

type

type: object

className

className: string = "RelationshipTypeMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fieldMappings

fieldMappings: object

required

required: true = true

serializedName

serializedName: string = "fieldMappings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RelationshipTypeFieldMapping"

name

name: "Composite" = "Composite"

Const RelationshipsLookup

RelationshipsLookup: object
interface

An interface representing RelationshipsLookup. The definition of suggested relationship for the type.

Optional existingRelationshipName

existingRelationshipName: undefined | string
member

{string} [existingRelationshipName] The name of existing Relationship. NOTE: This property will not be serialized. It can only be populated by the server.

Optional profileName

profileName: undefined | string
member

{string} [profileName] The relationship profile. NOTE: This property will not be serialized. It can only be populated by the server.

Optional profilePropertyReferences

profilePropertyReferences: ParticipantProfilePropertyReference[]
member

{ParticipantProfilePropertyReference[]} [profilePropertyReferences] The property references for the profile type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional relatedProfileName

relatedProfileName: undefined | string
member

{string} [relatedProfileName] The related profile. NOTE: This property will not be serialized. It can only be populated by the server.

Optional relatedProfilePropertyReferences

relatedProfilePropertyReferences: ParticipantProfilePropertyReference[]
member

{ParticipantProfilePropertyReference[]} [relatedProfilePropertyReferences] The property references for the related profile type. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RelationshipsLookup"

type

type: object

className

className: string = "RelationshipsLookup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

existingRelationshipName

existingRelationshipName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "existingRelationshipName"

type

type: object

name

name: "String" = "String"

profileName

profileName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "profileName"

type

type: object

name

name: "String" = "String"

profilePropertyReferences

profilePropertyReferences: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "profilePropertyReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParticipantProfilePropertyReference"

name

name: "Composite" = "Composite"

relatedProfileName

relatedProfileName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "relatedProfileName"

type

type: object

name

name: "String" = "String"

relatedProfilePropertyReferences

relatedProfilePropertyReferences: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "relatedProfilePropertyReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ParticipantProfilePropertyReference"

name

name: "Composite" = "Composite"

Const Resource

Resource: object
interface

An interface representing Resource. Common properties of Azure resource.

extends

BaseResource

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

serializedName

serializedName: string = "Resource"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceSetDescription

ResourceSetDescription: object
interface

An interface representing ResourceSetDescription. The resource set description.

Optional elements

elements: string[]
member

{string[]} [elements] The elements included in the set.

Optional exceptions

exceptions: string[]
member

{string[]} [exceptions] The elements that are not included in the set, in case elements contains '*' indicating 'all'.

serializedName

serializedName: string = "ResourceSetDescription"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

elements

elements: object

serializedName

serializedName: string = "elements"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

exceptions

exceptions: object

serializedName

serializedName: string = "exceptions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const RoleAssignmentListResult

RoleAssignmentListResult: object
interface

An interface representing the RoleAssignmentListResult. The response of list role assignment operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "RoleAssignmentListResult"

__@iterator

  • Iterator

    Returns IterableIterator<RoleAssignmentResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns RoleAssignmentResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RoleAssignmentResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RoleAssignmentResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RoleAssignmentResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns RoleAssignmentResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RoleAssignmentResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RoleAssignmentResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RoleAssignmentResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RoleAssignmentResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RoleAssignmentResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns RoleAssignmentResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns RoleAssignmentResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RoleAssignmentResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RoleAssignmentResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RoleAssignmentResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns RoleAssignmentResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RoleAssignmentResourceFormat>

type

type: object

className

className: string = "RoleAssignmentListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RoleAssignmentResourceFormat"

name

name: "Composite" = "Composite"

Const RoleAssignmentResourceFormat

RoleAssignmentResourceFormat: object
interface

An interface representing RoleAssignmentResourceFormat. The Role Assignment resource format.

extends

ProxyResource

Optional assignmentName

assignmentName: undefined | string
member

{string} [assignmentName] The name of the metadata object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional conflationPolicies

conflationPolicies: ResourceSetDescription
member

{ResourceSetDescription} [conflationPolicies] Widget types set for the assignment.

Optional connectors

member

{ResourceSetDescription} [connectors] Connectors set for the assignment.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized description for the metadata.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display names for the metadata.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional interactions

member

{ResourceSetDescription} [interactions] Interactions set for the assignment.

Optional kpis

member

{ResourceSetDescription} [kpis] Kpis set for the assignment.

Optional links

member

{ResourceSetDescription} [links] Links set for the assignment.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

principals

principals: AssignmentPrincipal[]
member

{AssignmentPrincipal[]} principals The principals being assigned to.

Optional profiles

member

{ResourceSetDescription} [profiles] Profiles set for the assignment.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional relationshipLinks

relationshipLinks: ResourceSetDescription
member

{ResourceSetDescription} [relationshipLinks] The Role assignments set for the relationship links.

Optional relationships

relationships: ResourceSetDescription
member

{ResourceSetDescription} [relationships] The Role assignments set for the relationships.

role

role: RoleTypes
member

{RoleTypes} role Type of roles. Possible values include: 'Admin', 'Reader', 'ManageAdmin', 'ManageReader', 'DataAdmin', 'DataReader'

Optional roleAssignments

roleAssignments: ResourceSetDescription
member

{ResourceSetDescription} [roleAssignments] The Role assignments set for the assignment.

Optional sasPolicies

member

{ResourceSetDescription} [sasPolicies] Sas Policies set for the assignment.

Optional segments

member

{ResourceSetDescription} [segments] The Role assignments set for the assignment.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional views

member

{ResourceSetDescription} [views] Views set for the assignment.

Optional widgetTypes

member

{ResourceSetDescription} [widgetTypes] Widget types set for the assignment.

serializedName

serializedName: string = "RoleAssignmentResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RoleAssignmentResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

assignmentName

assignmentName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.assignmentName"

type

type: object

name

name: "String" = "String"

conflationPolicies

conflationPolicies: object

serializedName

serializedName: string = "properties.conflationPolicies"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

connectors

connectors: object

serializedName

serializedName: string = "properties.connectors"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

interactions

interactions: object

serializedName

serializedName: string = "properties.interactions"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

kpis

kpis: object

serializedName

serializedName: string = "properties.kpis"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

links

links: object

serializedName

serializedName: string = "properties.links"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

principals

principals: object

required

required: true = true

serializedName

serializedName: string = "properties.principals"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AssignmentPrincipal"

name

name: "Composite" = "Composite"

profiles

profiles: object

serializedName

serializedName: string = "properties.profiles"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

relationshipLinks

relationshipLinks: object

serializedName

serializedName: string = "properties.relationshipLinks"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

relationships

relationships: object

serializedName

serializedName: string = "properties.relationships"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

role

role: object

required

required: true = true

serializedName

serializedName: string = "properties.role"

type

type: object

allowedValues

allowedValues: string[] = ["Admin","Reader","ManageAdmin","ManageReader","DataAdmin","DataReader"]

name

name: "Enum" = "Enum"

roleAssignments

roleAssignments: object

serializedName

serializedName: string = "properties.roleAssignments"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

sasPolicies

sasPolicies: object

serializedName

serializedName: string = "properties.sasPolicies"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

segments

segments: object

serializedName

serializedName: string = "properties.segments"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

views

views: object

serializedName

serializedName: string = "properties.views"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

widgetTypes

widgetTypes: object

serializedName

serializedName: string = "properties.widgetTypes"

type

type: object

className

className: string = "ResourceSetDescription"

name

name: "Composite" = "Composite"

Const RoleListResult

RoleListResult: object
interface

An interface representing the RoleListResult. The response of list role assignment operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "RoleListResult"

__@iterator

  • Iterator

    Returns IterableIterator<RoleResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RoleResourceFormat>[]

      Additional items to add to the end of array1.

    Returns RoleResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RoleResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RoleResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RoleResourceFormat, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RoleResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RoleResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RoleResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RoleResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RoleResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RoleResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RoleResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RoleResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RoleResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RoleResourceFormat

  • Parameters

    Returns RoleResourceFormat

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RoleResourceFormat

  • Parameters

    Returns RoleResourceFormat

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns RoleResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns RoleResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RoleResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RoleResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RoleResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns RoleResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RoleResourceFormat>

type

type: object

className

className: string = "RoleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RoleResourceFormat"

name

name: "Composite" = "Composite"

Const RoleResourceFormat

RoleResourceFormat: object
interface

An interface representing RoleResourceFormat. The role resource format.

extends

ProxyResource

Optional description

description: undefined | string
member

{string} [description] The description of the role.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional roleName

roleName: undefined | string
member

{string} [roleName] The role name.

serializedName

serializedName: string = "RoleResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RoleResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

roleName

roleName: object

serializedName

serializedName: string = "properties.roleName"

type

type: object

name

name: "String" = "String"

Const SalesforceConnectorProperties

SalesforceConnectorProperties: object
interface

An interface representing SalesforceConnectorProperties. The Salesforce connector properties.

salesforcetables

salesforcetables: SalesforceTable[]
member

{SalesforceTable[]} salesforcetables The Salesforce tables.

usersetting

member

{SalesforceDiscoverSetting} usersetting The user settings.

serializedName

serializedName: string = "SalesforceConnectorProperties"

type

type: object

className

className: string = "SalesforceConnectorProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

salesforcetables

salesforcetables: object

required

required: true = true

serializedName

serializedName: string = "salesforcetables"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SalesforceTable"

name

name: "Composite" = "Composite"

usersetting

usersetting: object

required

required: true = true

serializedName

serializedName: string = "usersetting"

type

type: object

className

className: string = "SalesforceDiscoverSetting"

name

name: "Composite" = "Composite"

Const SalesforceDiscoverSetting

SalesforceDiscoverSetting: object
interface

An interface representing SalesforceDiscoverSetting. Salesforce discover setting.

salesforceConnectionStringSecretUrl

salesforceConnectionStringSecretUrl: string
member

{string} salesforceConnectionStringSecretUrl The salesforce connection string secret URL.

serializedName

serializedName: string = "SalesforceDiscoverSetting"

type

type: object

className

className: string = "SalesforceDiscoverSetting"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

salesforceConnectionStringSecretUrl

salesforceConnectionStringSecretUrl: object

required

required: true = true

serializedName

serializedName: string = "salesforceConnectionStringSecretUrl"

type

type: object

name

name: "String" = "String"

Const SalesforceTable

SalesforceTable: object
interface

An interface representing SalesforceTable. Salesforce table.

Optional isProfile

isProfile: undefined | string
member

{string} [isProfile] Indicating whether this instance is profile.

tableCategory

tableCategory: string
member

{string} tableCategory The table category.

tableName

tableName: string
member

{string} tableName The name of the table.

Optional tableRemarks

tableRemarks: undefined | string
member

{string} [tableRemarks] The table remarks.

tableSchema

tableSchema: string
member

{string} tableSchema The table schema.

serializedName

serializedName: string = "SalesforceTable"

type

type: object

className

className: string = "SalesforceTable"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isProfile

isProfile: object

serializedName

serializedName: string = "isProfile"

type

type: object

name

name: "String" = "String"

tableCategory

tableCategory: object

required

required: true = true

serializedName

serializedName: string = "tableCategory"

type

type: object

name

name: "String" = "String"

tableName

tableName: object

required

required: true = true

serializedName

serializedName: string = "tableName"

type

type: object

name

name: "String" = "String"

tableRemarks

tableRemarks: object

serializedName

serializedName: string = "tableRemarks"

type

type: object

name

name: "String" = "String"

tableSchema

tableSchema: object

required

required: true = true

serializedName

serializedName: string = "tableSchema"

type

type: object

name

name: "String" = "String"

Const StrongId

StrongId: object
interface

An interface representing StrongId. Property/Properties which represent a unique ID.

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name.

keyPropertyNames

keyPropertyNames: string[]
member

{string[]} keyPropertyNames The properties which make up the unique ID.

strongIdName

strongIdName: string
member

{string} strongIdName The Name identifying the strong ID.

serializedName

serializedName: string = "StrongId"

type

type: object

className

className: string = "StrongId"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

keyPropertyNames

keyPropertyNames: object

required

required: true = true

serializedName

serializedName: string = "keyPropertyNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

strongIdName

strongIdName: object

required

required: true = true

serializedName

serializedName: string = "strongIdName"

type

type: object

name

name: "String" = "String"

Const SuggestRelationshipLinksResponse

SuggestRelationshipLinksResponse: object
interface

An interface representing SuggestRelationshipLinksResponse. The response of suggest relationship links operation.

Optional interactionName

interactionName: undefined | string
member

{string} [interactionName] The interaction name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suggestedRelationships

suggestedRelationships: RelationshipsLookup[]
member

{RelationshipsLookup[]} [suggestedRelationships] Suggested relationships for the type. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SuggestRelationshipLinksResponse"

type

type: object

className

className: string = "SuggestRelationshipLinksResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

interactionName

interactionName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "interactionName"

type

type: object

name

name: "String" = "String"

suggestedRelationships

suggestedRelationships: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "suggestedRelationships"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RelationshipsLookup"

name

name: "Composite" = "Composite"

Const TypePropertiesMapping

TypePropertiesMapping: object
interface

An interface representing TypePropertiesMapping. Metadata for a Link's property mapping.

Optional linkType

linkType: LinkTypes
member

{LinkTypes} [linkType] Link type. Possible values include: 'UpdateAlways', 'CopyIfNull'

sourcePropertyName

sourcePropertyName: string
member

{string} sourcePropertyName Property name on the source Entity Type.

targetPropertyName

targetPropertyName: string
member

{string} targetPropertyName Property name on the target Entity Type.

serializedName

serializedName: string = "TypePropertiesMapping"

type

type: object

className

className: string = "TypePropertiesMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

linkType

linkType: object

serializedName

serializedName: string = "linkType"

type

type: object

allowedValues

allowedValues: string[] = ["UpdateAlways","CopyIfNull"]

name

name: "Enum" = "Enum"

sourcePropertyName

sourcePropertyName: object

required

required: true = true

serializedName

serializedName: string = "sourcePropertyName"

type

type: object

name

name: "String" = "String"

targetPropertyName

targetPropertyName: object

required

required: true = true

serializedName

serializedName: string = "targetPropertyName"

type

type: object

name

name: "String" = "String"

Const ViewListResult

ViewListResult: object
interface

An interface representing the ViewListResult. The response of list view operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "ViewListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ViewResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ViewResourceFormat>[]

      Additional items to add to the end of array1.

    Returns ViewResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ViewResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ViewResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ViewResourceFormat, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ViewResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ViewResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ViewResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ViewResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ViewResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ViewResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ViewResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ViewResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ViewResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ViewResourceFormat

  • Parameters

    Returns ViewResourceFormat

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ViewResourceFormat

  • Parameters

    Returns ViewResourceFormat

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ViewResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns ViewResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ViewResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ViewResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ViewResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns ViewResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ViewResourceFormat>

type

type: object

className

className: string = "ViewListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ViewResourceFormat"

name

name: "Composite" = "Composite"

Const ViewResourceFormat

ViewResourceFormat: object
interface

An interface representing ViewResourceFormat. The view resource format.

extends

ProxyResource

Optional changed

changed: Date
member

{Date} [changed] Date time when view was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

Optional created

created: Date
member

{Date} [created] Date time when view was created. NOTE: This property will not be serialized. It can only be populated by the server.

definition

definition: string
member

{string} definition View definition.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the view.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] the hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userId

userId: undefined | string
member

{string} [userId] the user ID.

Optional viewName

viewName: undefined | string
member

{string} [viewName] Name of the view. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ViewResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ViewResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changed

changed: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changed"

type

type: object

name

name: "DateTime" = "DateTime"

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

definition

definition: object

required

required: true = true

serializedName

serializedName: string = "properties.definition"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

userId

userId: object

serializedName

serializedName: string = "properties.userId"

type

type: object

name

name: "String" = "String"

viewName

viewName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.viewName"

type

type: object

name

name: "String" = "String"

Const WidgetTypeListResult

WidgetTypeListResult: object
interface

An interface representing the WidgetTypeListResult. The response of list widget type operation.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next set of results.

serializedName

serializedName: string = "WidgetTypeListResult"

__@iterator

  • Iterator

    Returns IterableIterator<WidgetTypeResourceFormat>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns WidgetTypeResourceFormat[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WidgetTypeResourceFormat[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WidgetTypeResourceFormat]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WidgetTypeResourceFormat

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WidgetTypeResourceFormat[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WidgetTypeResourceFormat[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WidgetTypeResourceFormat | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns WidgetTypeResourceFormat | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WidgetTypeResourceFormat

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WidgetTypeResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WidgetTypeResourceFormat

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns WidgetTypeResourceFormat | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns WidgetTypeResourceFormat[]

shift

  • Removes the first element from an array and returns it.

    Returns WidgetTypeResourceFormat | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WidgetTypeResourceFormat[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WidgetTypeResourceFormat[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WidgetTypeResourceFormat[]

      Elements to insert into the array in place of the deleted elements.

    Returns WidgetTypeResourceFormat[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<WidgetTypeResourceFormat>

type

type: object

className

className: string = "WidgetTypeListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WidgetTypeResourceFormat"

name

name: "Composite" = "Composite"

Const WidgetTypeResourceFormat

WidgetTypeResourceFormat: object
interface

An interface representing WidgetTypeResourceFormat. The WidgetTypeResourceFormat

extends

ProxyResource

Optional changed

changed: Date
member

{Date} [changed] Date time when widget type was last modified. NOTE: This property will not be serialized. It can only be populated by the server.

Optional created

created: Date
member

{Date} [created] Date time when widget type was created. NOTE: This property will not be serialized. It can only be populated by the server.

definition

definition: string
member

{string} definition Definition for widget type.

Optional description

description: undefined | string
member

{string} [description] Description for widget type.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the widget type.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional imageUrl

imageUrl: undefined | string
member

{string} [imageUrl] The image URL.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional widgetTypeName

widgetTypeName: undefined | string
member

{string} [widgetTypeName] Name of the widget type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional widgetVersion

widgetVersion: undefined | string
member

{string} [widgetVersion] The widget version.

serializedName

serializedName: string = "WidgetTypeResourceFormat"

Optional type

type: object
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "WidgetTypeResourceFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changed

changed: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changed"

type

type: object

name

name: "DateTime" = "DateTime"

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

definition

definition: object

required

required: true = true

serializedName

serializedName: string = "properties.definition"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

imageUrl

imageUrl: object

serializedName

serializedName: string = "properties.imageUrl"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.tenantId"

type

type: object

name

name: "String" = "String"

widgetTypeName

widgetTypeName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.widgetTypeName"

type

type: object

name

name: "String" = "String"

widgetVersion

widgetVersion: object

serializedName

serializedName: string = "properties.widgetVersion"

type

type: object

name

name: "String" = "String"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const assignmentName0

assignmentName0: object

parameterPath

parameterPath: string = "assignmentName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "assignmentName"

constraints

constraints: object

MaxLength

MaxLength: number = 128

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const assignmentName1

assignmentName1: object

parameterPath

parameterPath: string = "assignmentName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "assignmentName"

type

type: object

name

name: "String" = "String"

Const authorizationPolicyName0

authorizationPolicyName0: object

parameterPath

parameterPath: string = "authorizationPolicyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "authorizationPolicyName"

constraints

constraints: object

MaxLength

MaxLength: number = 50

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9]$|^[A-Za-z0-9][\w-\.]*[A-Za-z0-9]$/

type

type: object

name

name: "String" = "String"

Const authorizationPolicyName1

authorizationPolicyName1: object

parameterPath

parameterPath: string = "authorizationPolicyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "authorizationPolicyName"

type

type: object

name

name: "String" = "String"

Const connectorName0

connectorName0: object

parameterPath

parameterPath: string = "connectorName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "connectorName"

constraints

constraints: object

MaxLength

MaxLength: number = 128

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const connectorName1

connectorName1: object

parameterPath

parameterPath: string = "connectorName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "connectorName"

type

type: object

name

name: "String" = "String"

Const hubName0

hubName0: object

parameterPath

parameterPath: string = "hubName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "hubName"

constraints

constraints: object

MaxLength

MaxLength: number = 64

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9]+$/

type

type: object

name

name: "String" = "String"

Const hubName1

hubName1: object

parameterPath

parameterPath: string = "hubName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "hubName"

type

type: object

name

name: "String" = "String"

Const interactionName0

interactionName0: object

parameterPath

parameterPath: string = "interactionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "interactionName"

constraints

constraints: object

MaxLength

MaxLength: number = 128

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const interactionName1

interactionName1: object

parameterPath

parameterPath: string = "interactionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "interactionName"

type

type: object

name

name: "String" = "String"

Const kpiName0

kpiName0: object

parameterPath

parameterPath: string = "kpiName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "kpiName"

constraints

constraints: object

MaxLength

MaxLength: number = 512

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const kpiName1

kpiName1: object

parameterPath

parameterPath: string = "kpiName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "kpiName"

type

type: object

name

name: "String" = "String"

Const linkName0

linkName0: object

parameterPath

parameterPath: string = "linkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "linkName"

constraints

constraints: object

MaxLength

MaxLength: number = 512

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const linkName1

linkName1: object

parameterPath

parameterPath: string = "linkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "linkName"

type

type: object

name

name: "String" = "String"

Const localeCode

localeCode: object

parameterPath

parameterPath: string[] = ["options","localeCode"]

mapper

mapper: object

defaultValue

defaultValue: string = "en-us"

serializedName

serializedName: string = "locale-code"

type

type: object

name

name: "String" = "String"

Const mappingName0

mappingName0: object

parameterPath

parameterPath: string = "mappingName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "mappingName"

constraints

constraints: object

MaxLength

MaxLength: number = 128

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const mappingName1

mappingName1: object

parameterPath

parameterPath: string = "mappingName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "mappingName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const predictionName0

predictionName0: object

parameterPath

parameterPath: string = "predictionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "predictionName"

constraints

constraints: object

MaxLength

MaxLength: number = 512

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const predictionName1

predictionName1: object

parameterPath

parameterPath: string = "predictionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "predictionName"

type

type: object

name

name: "String" = "String"

Const profileName0

profileName0: object

parameterPath

parameterPath: string = "profileName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "profileName"

constraints

constraints: object

MaxLength

MaxLength: number = 128

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const profileName1

profileName1: object

parameterPath

parameterPath: string = "profileName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "profileName"

type

type: object

name

name: "String" = "String"

Const relationshipLinkName0

relationshipLinkName0: object

parameterPath

parameterPath: string = "relationshipLinkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "relationshipLinkName"

constraints

constraints: object

MaxLength

MaxLength: number = 512

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const relationshipLinkName1

relationshipLinkName1: object

parameterPath

parameterPath: string = "relationshipLinkName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "relationshipLinkName"

type

type: object

name

name: "String" = "String"

Const relationshipName0

relationshipName0: object

parameterPath

parameterPath: string = "relationshipName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "relationshipName"

constraints

constraints: object

MaxLength

MaxLength: number = 512

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-zA-Z][a-zA-Z0-9_]+$/

type

type: object

name

name: "String" = "String"

Const relationshipName1

relationshipName1: object

parameterPath

parameterPath: string = "relationshipName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "relationshipName"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const userId

userId: object

parameterPath

parameterPath: string = "userId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "userId"

type

type: object

name

name: "String" = "String"

Const viewName0

viewName0: object

parameterPath

parameterPath: string = "viewName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "viewName"

constraints

constraints: object

MaxLength

MaxLength: number = 512

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

Const viewName1

viewName1: object

parameterPath

parameterPath: string = "viewName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "viewName"

type

type: object

name

name: "String" = "String"

Const widgetTypeName

widgetTypeName: object

parameterPath

parameterPath: string = "widgetTypeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "widgetTypeName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc